<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
  <head><meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="OSXPhotos Template System" href="template_help.html"><link rel="prev" title="OSXPhotos Tutorial" href="tutorial.html">

    <!-- Generated with Sphinx 8.2.3 and Furo 2025.09.25 -->
        <title>OSXPhotos Command Line Interface (CLI) - osxphotos 0.74.2 documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
    <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=580074bf" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
    
    


<style>
  body {
    --color-code-background: #f2f2f2;
  --color-code-foreground: #1e1e1e;
  
  }
  @media not print {
    body[data-theme="dark"] {
      --color-code-background: #202020;
  --color-code-foreground: #d0d0d0;
  
    }
    @media (prefers-color-scheme: dark) {
      body:not([data-theme="light"]) {
        --color-code-background: #202020;
  --color-code-foreground: #d0d0d0;
  
      }
    }
  }
</style></head>
  <body>
    
    <script>
      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
    </script>
    

<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
  <symbol id="svg-toc" viewBox="0 0 24 24">
    <title>Contents</title>
    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
      <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
    </svg>
  </symbol>
  <symbol id="svg-menu" viewBox="0 0 24 24">
    <title>Menu</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
      <line x1="3" y1="12" x2="21" y2="12"></line>
      <line x1="3" y1="6" x2="21" y2="6"></line>
      <line x1="3" y1="18" x2="21" y2="18"></line>
    </svg>
  </symbol>
  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
    <title>Expand</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
      <polyline points="9 18 15 12 9 6"></polyline>
    </svg>
  </symbol>
  <symbol id="svg-sun" viewBox="0 0 24 24">
    <title>Light mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
      <circle cx="12" cy="12" r="5"></circle>
      <line x1="12" y1="1" x2="12" y2="3"></line>
      <line x1="12" y1="21" x2="12" y2="23"></line>
      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
      <line x1="1" y1="12" x2="3" y2="12"></line>
      <line x1="21" y1="12" x2="23" y2="12"></line>
      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
    </svg>
  </symbol>
  <symbol id="svg-moon" viewBox="0 0 24 24">
    <title>Dark mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
      <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
    </svg>
  </symbol>
  <symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
    <title>Auto light/dark, in light mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
      <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
      <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
      <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
      <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
      <line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
      <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
      <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
      <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
      <line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
      <circle cx="14.5" cy="9.55" r="3.6"/>
    </svg>
  </symbol>
  <symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
    <title>Auto light/dark, in dark mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
      <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
      <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
      <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
      <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
      <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
      <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
      <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
      <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
      <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
      <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
    </svg>
  </symbol>
  <symbol id="svg-pencil" viewBox="0 0 24 24">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
      <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
      <path d="M13.5 6.5l4 4" />
      <path d="M20 21l2 -2l-2 -2" />
      <path d="M17 17l-2 2l2 2" />
    </svg>
  </symbol>
  <symbol id="svg-eye" viewBox="0 0 24 24">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
      <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
      <path
        d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
      <path d="M20 21l2 -2l-2 -2" />
      <path d="M17 17l-2 2l2 2" />
    </svg>
  </symbol>
</svg>

<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></label>

<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>



<div class="page">
  <header class="mobile-header">
    <div class="header-left">
      <label class="nav-overlay-icon" for="__navigation">
        <span class="icon"><svg><use href="#svg-menu"></use></svg></span>
      </label>
    </div>
    <div class="header-center">
      <a href="index.html"><div class="brand">osxphotos 0.74.2 documentation</div></a>
    </div>
    <div class="header-right">
      <div class="theme-toggle-container theme-toggle-header">
        <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
          <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
          <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
        </button>
      </div>
      <label class="toc-overlay-icon toc-header-icon" for="__toc">
        <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
      </label>
    </div>
  </header>
  <aside class="sidebar-drawer">
    <div class="sidebar-container">
      
      <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
  
  <span class="sidebar-brand-text">osxphotos 0.74.2 documentation</span>
  
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
  <input type="hidden" name="check_keywords" value="yes">
  <input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
  <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">OSXPhotos</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">OSXPhotos Tutorial</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">OSXPhotos Command Line Interface (CLI)</a></li>
<li class="toctree-l1"><a class="reference internal" href="template_help.html">OSXPhotos Template System</a></li>
<li class="toctree-l1"><a class="reference internal" href="package_overview.html">OSXPhotos Python Package Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="API_README.html">OSXPhotos Python API</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">OSXPhotos Python Reference</a></li>
</ul>

</div>
</div>

      </div>
      
    </div>
  </aside>
  <div class="main">
    <div class="content">
      <div class="article-container">
        <a href="#" class="back-to-top muted-link">
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
          </svg>
          <span>Back to top</span>
        </a>
        <div class="content-icon-container">
          <div class="view-this-page">
  <a class="muted-link" href="_sources/cli.rst.txt" title="View this page">
    <svg><use href="#svg-eye"></use></svg>
    <span class="visually-hidden">View this page</span>
  </a>
</div>
<div class="theme-toggle-container theme-toggle-content">
            <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
              <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
              <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
            </button>
          </div>
          <label class="toc-overlay-icon toc-content-icon" for="__toc">
            <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
          </label>
        </div>
        <article role="main" id="furo-main-content">
          <section id="osxphotos-command-line-interface-cli">
<h1>OSXPhotos Command Line Interface (CLI)<a class="headerlink" href="#osxphotos-command-line-interface-cli" title="Link to this heading">¶</a></h1>
<section id="osxphotos">
<h2>osxphotos<a class="headerlink" href="#osxphotos" title="Link to this heading">¶</a></h2>
<p>OSXPhotos: the multi-tool for your Photos library.</p>
<p>To get help on a specific command, use &quot;osxphotos COMMAND --help&quot;
or &quot;osxphotos help COMMAND&quot;; for example, &quot;osxphotos help export&quot;.</p>
<p>To search help for a specific topic within a command, run</p>
<p>&quot;osxphotos help COMMAND TOPIC&quot;; for example,</p>
<p>&quot;osxphotos help export keyword&quot; to get help related to keywords
when using the export command.</p>
<p>To see the full documentation in your browser, run &quot;osxphotos docs&quot;.</p>
<p>Some advanced commands are hidden by default. To see all commands,
run &quot;OSXPHOTOS_SHOW_HIDDEN=1 osxphotos help&quot;. Some commands also have
hidden options. These can be seen by running
&quot;OSXPHOTOS_SHOW_HIDDEN=1 osxphotos help COMMAND&quot;.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-v">
<span id="cmdoption-osxphotos-version"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-v" title="Link to this definition">¶</a></dt>
<dd><p>Show the version and exit.</p>
</dd></dl>

<section id="osxphotos-about">
<h3>about<a class="headerlink" href="#osxphotos-about" title="Link to this heading">¶</a></h3>
<p>Print information about osxphotos including license.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>about<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
</section>
<section id="osxphotos-add-locations">
<h3>add-locations<a class="headerlink" href="#osxphotos-add-locations" title="Link to this heading">¶</a></h3>
<p>Add missing location data to photos in Photos.app using nearest neighbor.</p>
<p>This command will search for photos that are missing location data and look
for the nearest neighbor photo within a given window of time that contains
location information. If a photo is found within the window of time, the
location of the nearest neighbor will be used to update the location of the
photo.</p>
<p>For example, if you took pictures with your iPhone and also with a camera that
doesn't have location information, you can use this command to add location
information to the photos taken with the camera from those taken with the
iPhone.</p>
<p>If you have many photos with missing location information but no nearest neighbor
within the window of time, you could add location information to some photos manually
then run this command again to add location information to the remaining photos.</p>
<p>You can specify a subset of photos to update using the query options.  For example,
'--selected' to update only the selected photos, '--added-after 2020-01-01' to update
only photos added after Jan 1, 2020, etc.</p>
<p>Example:</p>
<p>Add location data to all photos with missing location data within a ±2 hour window:</p>
<p>'osxphotos add-locations --window &quot;2 hr&quot; --verbose'</p>
<p>The add-locations command assumes that photos already have the correct date and time.
If you have photos that are missing both location data and date/time information,
you can use 'osxphotos timewarp' to add date/time information to the photos and then
use 'osxphotos add-locations' to add location information.
See 'osxphotos help timewarp' for more information.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>add-locations<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-w">
<span id="cmdoption-osxphotos-add-locations-window"></span><span class="sig-name descname"><span class="pre">-w</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--window</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;window&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-w" title="Link to this definition">¶</a></dt>
<dd><p>Window of time to search for nearest neighbor; searches +/- window of time.  Default is 1 hour. Format is one of 'HH:MM:SS', 'D days', 'H hours' (or hr), 'M minutes' (or min), 'S seconds' (or sec), 'S' (where S is seconds).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-dry-run">
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-dry-run" title="Link to this definition">¶</a></dt>
<dd><p>Don't actually add location, just print what would be done. Most useful with --verbose.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-V">
<span id="cmdoption-osxphotos-add-locations-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-timestamp">
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-timestamp" title="Link to this definition">¶</a></dt>
<dd><p>Add time stamp to verbose output</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-keyword">
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;KEYWORD&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with keyword KEYWORD. If more than one keyword, treated as &quot;OR&quot;, e.g. find photos matching any keyword</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-keyword">
<span class="sig-name descname"><span class="pre">--no-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no keyword.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-person">
<span class="sig-name descname"><span class="pre">--person</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PERSON&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-person" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with person PERSON. If more than one person, treated as &quot;OR&quot;, e.g. find photos matching any person</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-album">
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in album ALBUM. If more than one album, treated as &quot;OR&quot;, e.g. find photos matching any album. For albums in a folder, specify the entire folder path, e.g. 'My Folder/My Album'. If album name contains a forward slash, use double slashes to escape it, e.g. 'Travel//2025' for an album named 'Travel/2025'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-folder">
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FOLDER&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-folder" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in an album in folder FOLDER. If more than one folder, treated as &quot;OR&quot;, e.g. find photos in any FOLDER. To search subfolders, specify the entire folder path, e.g. 'My Folder/Subfolder'. If folder name contains a forward slash, use double slashes to escape it, e.g. 'My Folder//Subfolder' for a folder named 'My Folder/Subfolder'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-name">
<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILENAME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-name" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with filename matching FILENAME. If more than one --name options is specified, they are treated as &quot;OR&quot;, e.g. find photos matching any FILENAME.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-uuid">
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-uuid" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-uuid-from-file">
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-uuid-from-file" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is '-', read UUIDs from stdin.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-title">
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TITLE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for TITLE in title of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-title">
<span class="sig-name descname"><span class="pre">--no-title</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no title.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-description">
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DESC&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for DESC in description of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-description">
<span class="sig-name descname"><span class="pre">--no-description</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no description.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-place">
<span class="sig-name descname"><span class="pre">--place</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PLACE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for PLACE in photo's reverse geolocation info</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-place">
<span class="sig-name descname"><span class="pre">--no-place</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated place name info (no reverse geolocation info)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-location">
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with associated location info (e.g. GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-location">
<span class="sig-name descname"><span class="pre">--no-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated location info (e.g. no GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-label">
<span class="sig-name descname"><span class="pre">--label</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;LABEL&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-label" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with image classification label LABEL (Photos 5+ only). If more than one label, treated as &quot;OR&quot;, e.g. find photos matching any label</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-uti">
<span class="sig-name descname"><span class="pre">--uti</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UTI&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-uti" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos whose uniform type identifier (UTI) matches UTI</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-i">
<span id="cmdoption-osxphotos-add-locations-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-i" title="Link to this definition">¶</a></dt>
<dd><p>Case insensitive search when used with other query options.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-edited">
<span class="sig-name descname"><span class="pre">--edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-edited">
<span class="sig-name descname"><span class="pre">--not-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-external-edit">
<span class="sig-name descname"><span class="pre">--external-edit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-external-edit" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos edited in external editor.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-favorite">
<span class="sig-name descname"><span class="pre">--favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-favorite">
<span class="sig-name descname"><span class="pre">--not-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-hidden">
<span class="sig-name descname"><span class="pre">--hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-hidden">
<span class="sig-name descname"><span class="pre">--not-hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-shared">
<span class="sig-name descname"><span class="pre">--shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-shared" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in shared iCloud album (Photos 5+ only).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-shared">
<span class="sig-name descname"><span class="pre">--not-shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-shared" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not in shared iCloud album (Photos 5+ only).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-burst">
<span class="sig-name descname"><span class="pre">--burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were taken in a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-burst">
<span class="sig-name descname"><span class="pre">--not-burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-live">
<span class="sig-name descname"><span class="pre">--live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple live photos</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-live">
<span class="sig-name descname"><span class="pre">--not-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple live photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-portrait">
<span class="sig-name descname"><span class="pre">--portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-portrait">
<span class="sig-name descname"><span class="pre">--not-portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-screenshot">
<span class="sig-name descname"><span class="pre">--screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-screenshot">
<span class="sig-name descname"><span class="pre">--not-screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-screen-recording">
<span class="sig-name descname"><span class="pre">--screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for screen-recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-screen-recording">
<span class="sig-name descname"><span class="pre">--not-screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screen recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-slow-mo">
<span class="sig-name descname"><span class="pre">--slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-slow-mo">
<span class="sig-name descname"><span class="pre">--not-slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-time-lapse">
<span class="sig-name descname"><span class="pre">--time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-time-lapse">
<span class="sig-name descname"><span class="pre">--not-time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-hdr">
<span class="sig-name descname"><span class="pre">--hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for high dynamic range (HDR) photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-hdr">
<span class="sig-name descname"><span class="pre">--not-hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not HDR photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-selfie">
<span class="sig-name descname"><span class="pre">--selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for selfies (photos taken with front-facing cameras).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-selfie">
<span class="sig-name descname"><span class="pre">--not-selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not selfies.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-panorama">
<span class="sig-name descname"><span class="pre">--panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for panorama photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-panorama">
<span class="sig-name descname"><span class="pre">--not-panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not panoramas.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-has-raw">
<span class="sig-name descname"><span class="pre">--has-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-has-raw" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with both a jpeg and raw version</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-only-movies">
<span class="sig-name descname"><span class="pre">--only-movies</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-only-movies" title="Link to this definition">¶</a></dt>
<dd><p>Search only for movies (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-only-photos">
<span class="sig-name descname"><span class="pre">--only-photos</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-only-photos" title="Link to this definition">¶</a></dt>
<dd><p>Search only for photos/images (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-from-date">
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-from-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-to-date">
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-to-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-from-time">
<span class="sig-name descname"><span class="pre">--from-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-from-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after TIME of day, e.g. 12:00, or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-to-time">
<span class="sig-name descname"><span class="pre">--to-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;to_time&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-to-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before TIME of day, e.g. 12:00 or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-year">
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;YEAR&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-year" title="Link to this definition">¶</a></dt>
<dd><p>Search for items from a specific year, e.g. --year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-added-before">
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-added-before" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library before a specific date/time, e.g. --added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-added-after">
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-added-after" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library on or after a specific date/time, e.g. --added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-added-in-last">
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME_DELTA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-added-in-last" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like '12 hrs', '1 day', '1d', '1 week', '2weeks', '1 month', '1 year'. for example, '--added-in-last 7d' and '--added-in-last '1 week'' are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-has-comment">
<span class="sig-name descname"><span class="pre">--has-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-has-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-comment">
<span class="sig-name descname"><span class="pre">--no-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-has-likes">
<span class="sig-name descname"><span class="pre">--has-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-has-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-likes">
<span class="sig-name descname"><span class="pre">--no-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-is-reference">
<span class="sig-name descname"><span class="pre">--is-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-is-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were imported as referenced files (not copied into Photos library).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-reference">
<span class="sig-name descname"><span class="pre">--not-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not references, that is, they were copied into the Photos library and are managed by Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-in-album">
<span class="sig-name descname"><span class="pre">--in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in one or more albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-in-album">
<span class="sig-name descname"><span class="pre">--not-in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in any albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-duplicate">
<span class="sig-name descname"><span class="pre">--duplicate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-duplicate" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with possible duplicates. osxphotos will compare signatures of photos, evaluating date created, size, height, width, and edited status to find <em>possible</em> duplicates. This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple times or duplicated within Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-min-size">
<span class="sig-name descname"><span class="pre">--min-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-min-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &gt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-max-size">
<span class="sig-name descname"><span class="pre">--max-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-max-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &lt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-missing">
<span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos missing from disk.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-missing">
<span class="sig-name descname"><span class="pre">--not-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos present on disk (e.g. not missing).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-cloudasset">
<span class="sig-name descname"><span class="pre">--cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-cloudasset">
<span class="sig-name descname"><span class="pre">--not-cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-incloud">
<span class="sig-name descname"><span class="pre">--incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in iCloud (have been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-incloud">
<span class="sig-name descname"><span class="pre">--not-incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in iCloud (have not been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-syndicated">
<span class="sig-name descname"><span class="pre">--syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-syndicated">
<span class="sig-name descname"><span class="pre">--not-syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-saved-to-library">
<span class="sig-name descname"><span class="pre">--saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-saved-to-library">
<span class="sig-name descname"><span class="pre">--not-saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have not saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-shared-moment">
<span class="sig-name descname"><span class="pre">--shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-shared-moment">
<span class="sig-name descname"><span class="pre">--not-shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-shared-library">
<span class="sig-name descname"><span class="pre">--shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-shared-library">
<span class="sig-name descname"><span class="pre">--not-shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-regex">
<span class="sig-name descname"><span class="pre">--regex</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REGEX</span> <span class="pre">TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-regex" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where TEMPLATE matches regular expression REGEX. For example, to find photos in an album that begins with 'Beach': '--regex &quot;^Beach&quot; &quot;{album}&quot;'. You may specify more than one regular expression match by repeating '--regex' with different arguments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-selected">
<span class="sig-name descname"><span class="pre">--selected</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-selected" title="Link to this definition">¶</a></dt>
<dd><p>Filter for photos that are currently selected in Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-exif">
<span class="sig-name descname"><span class="pre">--exif</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXIF_TAG</span> <span class="pre">VALUE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-exif" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where EXIF_TAG exists in photo's EXIF data and contains VALUE. For example, to find photos created by Adobe Photoshop: '--exif Software 'Adobe Photoshop' 'or to find all photos shot on a Canon camera: '--exif Make Canon'. EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. 'EXIF:Make' or 'Make'. To use --exif, exiftool must be installed and in the path.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-query-eval">
<span class="sig-name descname"><span class="pre">--query-eval</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CRITERIA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-query-eval" title="Link to this definition">¶</a></dt>
<dd><p>Evaluate CRITERIA to filter photos. CRITERIA will be evaluated in context of the following python list comprehension: 'photos = [photo for photo in photos if CRITERIA]' where photo represents a PhotoInfo object. For example: '--query-eval photo.favorite' returns all photos that have been favorited and is equivalent to --favorite. You may specify more than one CRITERIA by using --query-eval multiple times. CRITERIA must be a valid python expression. See <a class="reference external" href="https://rhettbull.github.io/osxphotos/">https://rhettbull.github.io/osxphotos/</a> for additional documentation on the PhotoInfo class.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-query-function">
<span class="sig-name descname"><span class="pre">--query-function</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;filename.py:function&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-query-function" title="Link to this definition">¶</a></dt>
<dd><p>Run function to filter photos. Use this in format: --query-function filename.py:function where filename.py is a python file you've created and function is the name of the function in the python file you want to call. Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. You may use more than one function by repeating the --query-function option with a different value. Your query function will be called after all other query options have been evaluated. You may also specify a URL to a python file in the format: --query-function https://path/to/module.py::function See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of a query function.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-theme">
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-theme" title="Link to this definition">¶</a></dt>
<dd><p>Specify the color theme to use for output. Valid themes are 'dark', 'light', 'mono', and 'plain'. Defaults to 'dark' or 'light' depending on system dark mode setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>dark | light | mono | plain</p>
</dd>
</dl>
</dd></dl>

</section>
<section id="osxphotos-albums">
<h3>albums<a class="headerlink" href="#osxphotos-albums" title="Link to this heading">¶</a></h3>
<p>Print out albums found in the Photos library.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>albums<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-albums-library">
<span id="cmdoption-osxphotos-albums-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-albums-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-albums-json">
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-albums-json" title="Link to this definition">¶</a></dt>
<dd><p>Print output in JSON format.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-albums-s">
<span id="cmdoption-osxphotos-albums-size"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--size</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-albums-s" title="Link to this definition">¶</a></dt>
<dd><p>Sort albums by size instead of alphabetically</p>
</dd></dl>

</section>
<section id="osxphotos-batch-edit">
<h3>batch-edit<a class="headerlink" href="#osxphotos-batch-edit" title="Link to this heading">¶</a></h3>
<p>Batch edit photo metadata such as title, description, keywords, etc.
Operates on currently selected photos.</p>
<p>Select one or more photos in Photos then run this command to edit the metadata.
Alternatively, you can specify photos using one or more query options such as --album &quot;My Album&quot;
or --added-in-last &quot;1 day&quot;.</p>
<p>If you have an Album open and no photos selected, all photos in the album will be edited unless you
specify one or more query options.</p>
<p>For example:</p>
<div class="line-block">
<div class="line">osxphotos batch-edit </div>
<div class="line">--verbose </div>
<div class="line">--title &quot;California vacation 2023 {created.year}-{created.dd}-{created.mm} {counter:03d}&quot; </div>
<div class="line">--description &quot;{place.name}&quot; </div>
<div class="line">--keyword &quot;Family&quot; --keyword &quot;Travel&quot;</div>
</div>
<p>This will set the title to &quot;California vacation 2023 2023-02-20 001&quot;, and so on,
the description to the reverse geolocation place name,
and add the keywords &quot;Family&quot; and &quot;Travel&quot;.</p>
<p>--title, --description, and --keyword may be any valid template string.</p>
<p>See <a class="reference external" href="https://rhettbull.github.io/osxphotos/template_help.html">https://rhettbull.github.io/osxphotos/template_help.html</a></p>
<p>or 'osxphotos docs' for more information on the osxphotos template system.</p>
<p>It is recommended you test your edits on a small set of photos before applying them to many photos.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>batch-edit<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-t">
<span id="cmdoption-osxphotos-batch-edit-title"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TITLE_TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-t" title="Link to this definition">¶</a></dt>
<dd><p>Set title of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-d">
<span id="cmdoption-osxphotos-batch-edit-description"></span><span id="cmdoption-osxphotos-batch-edit-caption"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--caption</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DESCRIPTION_TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-d" title="Link to this definition">¶</a></dt>
<dd><p>Set description / caption of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-k">
<span id="cmdoption-osxphotos-batch-edit-keyword"></span><span class="sig-name descname"><span class="pre">-k</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;KEYWORD_TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-k" title="Link to this definition">¶</a></dt>
<dd><p>Add keywords to photo. May be specified multiple times.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-K">
<span id="cmdoption-osxphotos-batch-edit-replace-keywords"></span><span class="sig-name descname"><span class="pre">-K</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--replace-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-K" title="Link to this definition">¶</a></dt>
<dd><p>When specified with --keyword, replace existing keywords. Default is to add to existing keywords.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-l">
<span id="cmdoption-osxphotos-batch-edit-location"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;LATITUDE</span> <span class="pre">LONGITUDE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-l" title="Link to this definition">¶</a></dt>
<dd><p>Set location of photo. Must be specified as a pair of numbers with latitude in the range -90 to 90 and longitude in the range -180 to 180.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-F">
<span id="cmdoption-osxphotos-batch-edit-set-favorite"></span><span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--set-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-F" title="Link to this definition">¶</a></dt>
<dd><p>Set favorite flag for photo. If photo is already a favorite, --set-favorite has no effect. See also, --clear-favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-c">
<span id="cmdoption-osxphotos-batch-edit-clear-favorite"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--clear-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-c" title="Link to this definition">¶</a></dt>
<dd><p>Clear favorite flag for photo. If photo is not marked as favorite, --clear-favorite has no effect. See also, --set-favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-a">
<span id="cmdoption-osxphotos-batch-edit-add-to-album"></span><span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--add-to-album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM_TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-a" title="Link to this definition">¶</a></dt>
<dd><p>Add photo to album ALBUM_TEMPLATE. ALBUM_TEMPLATE is an osxphotos template string. Photos may be added to more than one album by repeating --add-to-album. See also, --split-folder. See Template System in help ('osxphotos docs') for additional information.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-f">
<span id="cmdoption-osxphotos-batch-edit-split-folder"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--split-folder</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;split_folder&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-f" title="Link to this definition">¶</a></dt>
<dd><p>When used with --add-to-album, automatically create hierarchal folders for albums as needed by splitting album name into folders and album. You must specify the character used to split folders and albums. For example, '--split-folder &quot;/&quot;' will split the album name 'Folder/Album' into folder 'Folder' and album 'Album'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-dry-run">
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-dry-run" title="Link to this definition">¶</a></dt>
<dd><p>Don't actually change anything.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-X">
<span id="cmdoption-osxphotos-batch-edit-undo"></span><span class="sig-name descname"><span class="pre">-X</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--undo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-X" title="Link to this definition">¶</a></dt>
<dd><p>Restores photo metadata to what it was prior to the last batch edit. May be combined with --dry-run to see what will be undone. Note: --undo cannot undo album changes at this time; photos added to an album with --add-to-album will remain in the album after --undo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-album">
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in album ALBUM. If more than one album, treated as &quot;OR&quot;, e.g. find photos matching any album. For albums in a folder, specify the entire folder path, e.g. 'My Folder/My Album'. If album name contains a forward slash, use double slashes to escape it, e.g. 'Travel//2025' for an album named 'Travel/2025'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-folder">
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FOLDER&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-folder" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in an album in folder FOLDER. If more than one folder, treated as &quot;OR&quot;, e.g. find photos in any FOLDER. To search subfolders, specify the entire folder path, e.g. 'My Folder/Subfolder'. If folder name contains a forward slash, use double slashes to escape it, e.g. 'My Folder//Subfolder' for a folder named 'My Folder/Subfolder'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-uuid">
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-uuid" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-uuid-from-file">
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-uuid-from-file" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is '-', read UUIDs from stdin.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-from-date">
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-from-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-to-date">
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-to-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-year">
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;YEAR&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-year" title="Link to this definition">¶</a></dt>
<dd><p>Search for items from a specific year, e.g. --year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-added-before">
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-added-before" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library before a specific date/time, e.g. --added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-added-after">
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-added-after" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library on or after a specific date/time, e.g. --added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-added-in-last">
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME_DELTA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-added-in-last" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like '12 hrs', '1 day', '1d', '1 week', '2weeks', '1 month', '1 year'. for example, '--added-in-last 7d' and '--added-in-last '1 week'' are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-i">
<span id="cmdoption-osxphotos-batch-edit-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-i" title="Link to this definition">¶</a></dt>
<dd><p>Case insensitive search when used with other query options.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-V">
<span id="cmdoption-osxphotos-batch-edit-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-timestamp">
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-timestamp" title="Link to this definition">¶</a></dt>
<dd><p>Add time stamp to verbose output</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-theme">
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-theme" title="Link to this definition">¶</a></dt>
<dd><p>Specify the color theme to use for output. Valid themes are 'dark', 'light', 'mono', and 'plain'. Defaults to 'dark' or 'light' depending on system dark mode setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>dark | light | mono | plain</p>
</dd>
</dl>
</dd></dl>

</section>
<section id="osxphotos-compare">
<h3>compare<a class="headerlink" href="#osxphotos-compare" title="Link to this heading">¶</a></h3>
<p>Compare two Photos libraries to find differences</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>compare<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>LIBRARY_A<span class="w"> </span>LIBRARY_B
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-compare-k">
<span id="cmdoption-osxphotos-compare-check"></span><span class="sig-name descname"><span class="pre">-k</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-compare-k" title="Link to this definition">¶</a></dt>
<dd><p>Check if libraries are different and print out total number of differences. If libraries are different, exits with error code 1, otherwise 0 if they are the same.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-compare-c">
<span id="cmdoption-osxphotos-compare-csv"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--csv</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-compare-c" title="Link to this definition">¶</a></dt>
<dd><p>Output results in CSV (comma delimited) format</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-compare-t">
<span id="cmdoption-osxphotos-compare-tsv"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--tsv</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-compare-t" title="Link to this definition">¶</a></dt>
<dd><p>Output results in TSV (tab delimited) format</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-compare-j">
<span id="cmdoption-osxphotos-compare-json"></span><span class="sig-name descname"><span class="pre">-j</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-compare-j" title="Link to this definition">¶</a></dt>
<dd><p>Output results in JSON format</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-compare-o">
<span id="cmdoption-osxphotos-compare-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;output&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-compare-o" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-compare-s">
<span id="cmdoption-osxphotos-compare-signature"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--signature</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;signature&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-compare-s" title="Link to this definition">¶</a></dt>
<dd><p>Custom template for signature. The signature is used to match photos from one library to another. The default is '{photo.original_filename|lower}:{photo.fingerprint}' which should work well in most cases.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-compare-V">
<span id="cmdoption-osxphotos-compare-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-compare-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-compare-arg-LIBRARY_A">
<span class="sig-name descname"><span class="pre">LIBRARY_A</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-compare-arg-LIBRARY_A" title="Link to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-compare-arg-LIBRARY_B">
<span class="sig-name descname"><span class="pre">LIBRARY_B</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-compare-arg-LIBRARY_B" title="Link to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>

</section>
<section id="osxphotos-docs">
<h3>docs<a class="headerlink" href="#osxphotos-docs" title="Link to this heading">¶</a></h3>
<p>Open osxphotos documentation in your browser.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>docs<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
</section>
<section id="osxphotos-dump">
<h3>dump<a class="headerlink" href="#osxphotos-dump" title="Link to this heading">¶</a></h3>
<p>Print list of all photos &amp; associated info from the Photos library.</p>
<p>NOTE: dump is DEPRECATED and will be removed in a future release.
Use 'osxphotos query' instead.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>dump<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-library">
<span id="cmdoption-osxphotos-dump-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-dump-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-json">
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-dump-json" title="Link to this definition">¶</a></dt>
<dd><p>Print output in JSON format.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-deleted-only">
<span class="sig-name descname"><span class="pre">--deleted-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-dump-deleted-only" title="Link to this definition">¶</a></dt>
<dd><p>Include only photos from the 'Recently Deleted' folder.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-deleted">
<span class="sig-name descname"><span class="pre">--deleted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-dump-deleted" title="Link to this definition">¶</a></dt>
<dd><p>Include photos from the 'Recently Deleted' folder.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-f">
<span id="cmdoption-osxphotos-dump-field"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--field</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FIELD</span> <span class="pre">TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-dump-f" title="Link to this definition">¶</a></dt>
<dd><p>Output only specified custom fields. FIELD is the name of the field and TEMPLATE is the template to use as the field value. May be repeated to output multiple fields. For example, to output photo uuid, name, and title: '--field uuid &quot;{uuid}&quot; --field name &quot;{original_name}&quot; --field title &quot;{title}&quot;'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-print">
<span class="sig-name descname"><span class="pre">--print</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-dump-print" title="Link to this definition">¶</a></dt>
<dd><p>Render TEMPLATE string for each photo queried and print to stdout. TEMPLATE is an osxphotos template string. This may be useful for creating custom reports, etc. If --print TEMPLATE is provided, regular output is suppressed and only the rendered TEMPLATE values are printed. May be repeated to print multiple template strings.</p>
</dd></dl>

</section>
<section id="osxphotos-exiftool">
<h3>exiftool<a class="headerlink" href="#osxphotos-exiftool" title="Link to this heading">¶</a></h3>
<p>Run exiftool on previously exported files to update metadata.</p>
<p>If you previously exported photos with 'osxphotos export' but did not include the
'--exiftool' option and you now want to update the metadata of the exported files with
exiftool, you can use this command to do so.</p>
<p>If you simply re-run the 'osxphotos export' with '--update' and '--exiftool', osxphotos will
re-export all photos because it will detect that the previously exported photos do not have the
exiftool metadata updates.  This command will run exiftool on the previously exported photos
to update all metadata then will update the export database so that using '--exiftool --update'
with 'osxphotos export' in the future will work correctly and not unnecessarily re-export photos.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>exiftool<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>EXPORT_DIRECTORY
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-db-config">
<span class="sig-name descname"><span class="pre">--db-config</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-db-config" title="Link to this definition">¶</a></dt>
<dd><p>Load configuration options from the export database to match the last export; If any other command line options are used in conjunction with --db-config, they will override the corresponding values loaded from the export database; see also --load-config.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-load-config">
<span class="sig-name descname"><span class="pre">--load-config</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CONFIG_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-load-config" title="Link to this definition">¶</a></dt>
<dd><p>Load options from file as written with --save-config. If any other command line options are used in conjunction with --load-config, they will override the corresponding values in the config file; see also --db-config.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-save-config">
<span class="sig-name descname"><span class="pre">--save-config</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CONFIG_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-save-config" title="Link to this definition">¶</a></dt>
<dd><p>Save options to file for use with --load-config. File format is TOML.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-exiftool-path">
<span class="sig-name descname"><span class="pre">--exiftool-path</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXIFTOOL_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-exiftool-path" title="Link to this definition">¶</a></dt>
<dd><p>Optionally specify path to exiftool; if not provided, will look for exiftool in $PATH.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-exiftool-option">
<span class="sig-name descname"><span class="pre">--exiftool-option</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;OPTION&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-exiftool-option" title="Link to this definition">¶</a></dt>
<dd><p>Optional flag/option to pass to exiftool when using --exiftool. For example, --exiftool-option '-m' to ignore minor warnings. Specify these as you would on the exiftool command line. See exiftool docs at <a class="reference external" href="https://exiftool.org/exiftool_pod.html">https://exiftool.org/exiftool_pod.html</a> for full list of options. More than one option may be specified by repeating the option, e.g. --exiftool-option '-m' --exiftool-option '-F'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-exiftool-merge-keywords">
<span class="sig-name descname"><span class="pre">--exiftool-merge-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-exiftool-merge-keywords" title="Link to this definition">¶</a></dt>
<dd><p>Merge any keywords found in the original file with keywords used for '--exiftool' and '--sidecar'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-exiftool-merge-persons">
<span class="sig-name descname"><span class="pre">--exiftool-merge-persons</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-exiftool-merge-persons" title="Link to this definition">¶</a></dt>
<dd><p>Merge any persons found in the original file with persons used for '--exiftool' and '--sidecar'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-ignore-date-modified">
<span class="sig-name descname"><span class="pre">--ignore-date-modified</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-ignore-date-modified" title="Link to this definition">¶</a></dt>
<dd><p>If used with --exiftool or --sidecar, will ignore the photo modification date and set EXIF:ModifyDate to EXIF:DateTimeOriginal; this is consistent with how Photos handles the EXIF:ModifyDate tag.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-person-keyword">
<span class="sig-name descname"><span class="pre">--person-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-person-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Use person in image as keyword/tag when exporting metadata.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-album-keyword">
<span class="sig-name descname"><span class="pre">--album-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-album-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Use album name as keyword/tag when exporting metadata.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-keyword-template">
<span class="sig-name descname"><span class="pre">--keyword-template</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-keyword-template" title="Link to this definition">¶</a></dt>
<dd><p>For use with --exiftool, --sidecar; specify a template string to use as keyword in the form '{name,DEFAULT}' This is the same format as --directory.  For example, if you wanted to add the full path to the folder and album photo is contained in as a keyword when exporting you could specify --keyword-template &quot;{folder_album}&quot; You may specify more than one template, for example --keyword-template &quot;{folder_album}&quot; --keyword-template &quot;{created.year}&quot;. See '--replace-keywords' and Templating System below.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-replace-keywords">
<span class="sig-name descname"><span class="pre">--replace-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-replace-keywords" title="Link to this definition">¶</a></dt>
<dd><p>Replace keywords with any values specified with --keyword-template. By default, --keyword-template will add keywords to any keywords already associated with the photo.  If --replace-keywords is specified, values from --keyword-template will replace any existing keywords instead of adding additional keywords.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-description-template">
<span class="sig-name descname"><span class="pre">--description-template</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-description-template" title="Link to this definition">¶</a></dt>
<dd><p>For use with --exiftool, --sidecar; specify a template string to use as description in the form '{name,DEFAULT}' This is the same format as --directory.  For example, if you wanted to append 'exported with osxphotos on [today's date]' to the description, you could specify --description-template &quot;{descr} exported with osxphotos on {today.date}&quot; See Templating System below.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-exportdb">
<span class="sig-name descname"><span class="pre">--exportdb</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;exportdb&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-exportdb" title="Link to this definition">¶</a></dt>
<dd><p>Optional path to export database (if not in the default location in the export directory).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-report">
<span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REPORT_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-report" title="Link to this definition">¶</a></dt>
<dd><p>Write a report of all files that were exported. The extension of the report filename will be used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). REPORT_FILE may be a template string (see Templating System), for example, --report 'export_{today.date}.csv' will write a CSV report file named with today's date. See also --append.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-append">
<span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-append" title="Link to this definition">¶</a></dt>
<dd><p>If used with --report, add data to existing report file instead of overwriting it. See also --report.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-V">
<span id="cmdoption-osxphotos-exiftool-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-timestamp">
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-timestamp" title="Link to this definition">¶</a></dt>
<dd><p>Add time stamp to verbose output</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-dry-run">
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-dry-run" title="Link to this definition">¶</a></dt>
<dd><p>Run in dry-run mode (don't actually update files), e.g. for use with --update-signatures.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-theme">
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-theme" title="Link to this definition">¶</a></dt>
<dd><p>Specify the color theme to use for output. Valid themes are 'dark', 'light', 'mono', and 'plain'. Defaults to 'dark' or 'light' depending on system dark mode setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>dark | light | mono | plain</p>
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-library">
<span id="cmdoption-osxphotos-exiftool-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-arg-EXPORT_DIRECTORY">
<span class="sig-name descname"><span class="pre">EXPORT_DIRECTORY</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-arg-EXPORT_DIRECTORY" title="Link to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>

</section>
<section id="osxphotos-export">
<h3>export<a class="headerlink" href="#osxphotos-export" title="Link to this heading">¶</a></h3>
<p>Export photos from the Photos database.
Export path DEST is required.</p>
<p>Optionally, query the Photos database using 1 or more search options;
if more than one different option is provided, they are treated as &quot;AND&quot;
(e.g. search for photos matching all options).
If the same query option is provided multiple times, they are treated as
&quot;OR&quot; (e.g. search for photos matching any of the options).
If no query options are provided, all photos will be exported.</p>
<p>For example, adding the query options:</p>
<p>--person &quot;John Doe&quot; --person &quot;Jane Doe&quot; --keyword &quot;vacation&quot;</p>
<p>will export all photos with either person of (&quot;John Doe&quot; OR &quot;Jane Doe&quot;) AND keyword of &quot;vacation&quot;</p>
<p>By default, all versions of all photos will be exported including edited
versions, live photo movies, burst photos, and associated raw images.
See --skip-edited, --skip-live, --skip-bursts, and --skip-raw options
to modify this behavior.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span><span class="nb">export</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>DEST
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-library">
<span id="cmdoption-osxphotos-export-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-V">
<span id="cmdoption-osxphotos-export-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-timestamp">
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-timestamp" title="Link to this definition">¶</a></dt>
<dd><p>Add time stamp to verbose output</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-progress">
<span class="sig-name descname"><span class="pre">--no-progress</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-progress" title="Link to this definition">¶</a></dt>
<dd><p>Do not display progress bar during export.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-keyword">
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;KEYWORD&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with keyword KEYWORD. If more than one keyword, treated as &quot;OR&quot;, e.g. find photos matching any keyword</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-keyword">
<span class="sig-name descname"><span class="pre">--no-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no keyword.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-person">
<span class="sig-name descname"><span class="pre">--person</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PERSON&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-person" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with person PERSON. If more than one person, treated as &quot;OR&quot;, e.g. find photos matching any person</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-album">
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in album ALBUM. If more than one album, treated as &quot;OR&quot;, e.g. find photos matching any album. For albums in a folder, specify the entire folder path, e.g. 'My Folder/My Album'. If album name contains a forward slash, use double slashes to escape it, e.g. 'Travel//2025' for an album named 'Travel/2025'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-folder">
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FOLDER&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-folder" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in an album in folder FOLDER. If more than one folder, treated as &quot;OR&quot;, e.g. find photos in any FOLDER. To search subfolders, specify the entire folder path, e.g. 'My Folder/Subfolder'. If folder name contains a forward slash, use double slashes to escape it, e.g. 'My Folder//Subfolder' for a folder named 'My Folder/Subfolder'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-name">
<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILENAME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-name" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with filename matching FILENAME. If more than one --name options is specified, they are treated as &quot;OR&quot;, e.g. find photos matching any FILENAME.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-uuid">
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-uuid" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-uuid-from-file">
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-uuid-from-file" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is '-', read UUIDs from stdin.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-title">
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TITLE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for TITLE in title of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-title">
<span class="sig-name descname"><span class="pre">--no-title</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no title.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-description">
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DESC&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for DESC in description of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-description">
<span class="sig-name descname"><span class="pre">--no-description</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no description.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-place">
<span class="sig-name descname"><span class="pre">--place</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PLACE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for PLACE in photo's reverse geolocation info</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-place">
<span class="sig-name descname"><span class="pre">--no-place</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated place name info (no reverse geolocation info)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-location">
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with associated location info (e.g. GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-location">
<span class="sig-name descname"><span class="pre">--no-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated location info (e.g. no GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-label">
<span class="sig-name descname"><span class="pre">--label</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;LABEL&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-label" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with image classification label LABEL (Photos 5+ only). If more than one label, treated as &quot;OR&quot;, e.g. find photos matching any label</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-uti">
<span class="sig-name descname"><span class="pre">--uti</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UTI&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-uti" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos whose uniform type identifier (UTI) matches UTI</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-i">
<span id="cmdoption-osxphotos-export-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-i" title="Link to this definition">¶</a></dt>
<dd><p>Case insensitive search when used with other query options.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-edited">
<span class="sig-name descname"><span class="pre">--edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-edited">
<span class="sig-name descname"><span class="pre">--not-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-external-edit">
<span class="sig-name descname"><span class="pre">--external-edit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-external-edit" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos edited in external editor.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-favorite">
<span class="sig-name descname"><span class="pre">--favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-favorite">
<span class="sig-name descname"><span class="pre">--not-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-hidden">
<span class="sig-name descname"><span class="pre">--hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-hidden">
<span class="sig-name descname"><span class="pre">--not-hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-shared">
<span class="sig-name descname"><span class="pre">--shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-shared" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in shared iCloud album (Photos 5+ only).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-shared">
<span class="sig-name descname"><span class="pre">--not-shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-shared" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not in shared iCloud album (Photos 5+ only).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-burst">
<span class="sig-name descname"><span class="pre">--burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were taken in a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-burst">
<span class="sig-name descname"><span class="pre">--not-burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-live">
<span class="sig-name descname"><span class="pre">--live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple live photos</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-live">
<span class="sig-name descname"><span class="pre">--not-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple live photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-portrait">
<span class="sig-name descname"><span class="pre">--portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-portrait">
<span class="sig-name descname"><span class="pre">--not-portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-screenshot">
<span class="sig-name descname"><span class="pre">--screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-screenshot">
<span class="sig-name descname"><span class="pre">--not-screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-screen-recording">
<span class="sig-name descname"><span class="pre">--screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for screen-recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-screen-recording">
<span class="sig-name descname"><span class="pre">--not-screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screen recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-slow-mo">
<span class="sig-name descname"><span class="pre">--slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-slow-mo">
<span class="sig-name descname"><span class="pre">--not-slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-time-lapse">
<span class="sig-name descname"><span class="pre">--time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-time-lapse">
<span class="sig-name descname"><span class="pre">--not-time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-hdr">
<span class="sig-name descname"><span class="pre">--hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for high dynamic range (HDR) photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-hdr">
<span class="sig-name descname"><span class="pre">--not-hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not HDR photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-selfie">
<span class="sig-name descname"><span class="pre">--selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for selfies (photos taken with front-facing cameras).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-selfie">
<span class="sig-name descname"><span class="pre">--not-selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not selfies.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-panorama">
<span class="sig-name descname"><span class="pre">--panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for panorama photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-panorama">
<span class="sig-name descname"><span class="pre">--not-panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not panoramas.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-has-raw">
<span class="sig-name descname"><span class="pre">--has-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-has-raw" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with both a jpeg and raw version</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-only-movies">
<span class="sig-name descname"><span class="pre">--only-movies</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-only-movies" title="Link to this definition">¶</a></dt>
<dd><p>Search only for movies (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-only-photos">
<span class="sig-name descname"><span class="pre">--only-photos</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-only-photos" title="Link to this definition">¶</a></dt>
<dd><p>Search only for photos/images (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-from-date">
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-from-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-to-date">
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-to-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-from-time">
<span class="sig-name descname"><span class="pre">--from-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-from-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after TIME of day, e.g. 12:00, or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-to-time">
<span class="sig-name descname"><span class="pre">--to-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;to_time&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-to-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before TIME of day, e.g. 12:00 or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-year">
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;YEAR&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-year" title="Link to this definition">¶</a></dt>
<dd><p>Search for items from a specific year, e.g. --year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-added-before">
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-added-before" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library before a specific date/time, e.g. --added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-added-after">
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-added-after" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library on or after a specific date/time, e.g. --added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-added-in-last">
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME_DELTA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-added-in-last" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like '12 hrs', '1 day', '1d', '1 week', '2weeks', '1 month', '1 year'. for example, '--added-in-last 7d' and '--added-in-last '1 week'' are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-has-comment">
<span class="sig-name descname"><span class="pre">--has-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-has-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-comment">
<span class="sig-name descname"><span class="pre">--no-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-has-likes">
<span class="sig-name descname"><span class="pre">--has-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-has-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-likes">
<span class="sig-name descname"><span class="pre">--no-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-is-reference">
<span class="sig-name descname"><span class="pre">--is-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-is-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were imported as referenced files (not copied into Photos library).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-reference">
<span class="sig-name descname"><span class="pre">--not-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not references, that is, they were copied into the Photos library and are managed by Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-in-album">
<span class="sig-name descname"><span class="pre">--in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in one or more albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-in-album">
<span class="sig-name descname"><span class="pre">--not-in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in any albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-duplicate">
<span class="sig-name descname"><span class="pre">--duplicate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-duplicate" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with possible duplicates. osxphotos will compare signatures of photos, evaluating date created, size, height, width, and edited status to find <em>possible</em> duplicates. This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple times or duplicated within Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-min-size">
<span class="sig-name descname"><span class="pre">--min-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-min-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &gt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-max-size">
<span class="sig-name descname"><span class="pre">--max-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-max-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &lt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-missing">
<span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos missing from disk.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-missing">
<span class="sig-name descname"><span class="pre">--not-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos present on disk (e.g. not missing).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-cloudasset">
<span class="sig-name descname"><span class="pre">--cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-cloudasset">
<span class="sig-name descname"><span class="pre">--not-cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-incloud">
<span class="sig-name descname"><span class="pre">--incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in iCloud (have been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-incloud">
<span class="sig-name descname"><span class="pre">--not-incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in iCloud (have not been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-syndicated">
<span class="sig-name descname"><span class="pre">--syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-syndicated">
<span class="sig-name descname"><span class="pre">--not-syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-saved-to-library">
<span class="sig-name descname"><span class="pre">--saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-saved-to-library">
<span class="sig-name descname"><span class="pre">--not-saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have not saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-shared-moment">
<span class="sig-name descname"><span class="pre">--shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-shared-moment">
<span class="sig-name descname"><span class="pre">--not-shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-shared-library">
<span class="sig-name descname"><span class="pre">--shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-shared-library">
<span class="sig-name descname"><span class="pre">--not-shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-regex">
<span class="sig-name descname"><span class="pre">--regex</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REGEX</span> <span class="pre">TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-regex" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where TEMPLATE matches regular expression REGEX. For example, to find photos in an album that begins with 'Beach': '--regex &quot;^Beach&quot; &quot;{album}&quot;'. You may specify more than one regular expression match by repeating '--regex' with different arguments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-selected">
<span class="sig-name descname"><span class="pre">--selected</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-selected" title="Link to this definition">¶</a></dt>
<dd><p>Filter for photos that are currently selected in Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exif">
<span class="sig-name descname"><span class="pre">--exif</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXIF_TAG</span> <span class="pre">VALUE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-exif" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where EXIF_TAG exists in photo's EXIF data and contains VALUE. For example, to find photos created by Adobe Photoshop: '--exif Software 'Adobe Photoshop' 'or to find all photos shot on a Canon camera: '--exif Make Canon'. EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. 'EXIF:Make' or 'Make'. To use --exif, exiftool must be installed and in the path.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-query-eval">
<span class="sig-name descname"><span class="pre">--query-eval</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CRITERIA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-query-eval" title="Link to this definition">¶</a></dt>
<dd><p>Evaluate CRITERIA to filter photos. CRITERIA will be evaluated in context of the following python list comprehension: 'photos = [photo for photo in photos if CRITERIA]' where photo represents a PhotoInfo object. For example: '--query-eval photo.favorite' returns all photos that have been favorited and is equivalent to --favorite. You may specify more than one CRITERIA by using --query-eval multiple times. CRITERIA must be a valid python expression. See <a class="reference external" href="https://rhettbull.github.io/osxphotos/">https://rhettbull.github.io/osxphotos/</a> for additional documentation on the PhotoInfo class.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-query-function">
<span class="sig-name descname"><span class="pre">--query-function</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;filename.py:function&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-query-function" title="Link to this definition">¶</a></dt>
<dd><p>Run function to filter photos. Use this in format: --query-function filename.py:function where filename.py is a python file you've created and function is the name of the function in the python file you want to call. Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. You may use more than one function by repeating the --query-function option with a different value. Your query function will be called after all other query options have been evaluated. You may also specify a URL to a python file in the format: --query-function https://path/to/module.py::function See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of a query function.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-deleted-only">
<span class="sig-name descname"><span class="pre">--deleted-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-deleted-only" title="Link to this definition">¶</a></dt>
<dd><p>Include only photos from the 'Recently Deleted' folder.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-deleted">
<span class="sig-name descname"><span class="pre">--deleted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-deleted" title="Link to this definition">¶</a></dt>
<dd><p>Include photos from the 'Recently Deleted' folder.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-update">
<span class="sig-name descname"><span class="pre">--update</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-update" title="Link to this definition">¶</a></dt>
<dd><p>Only export new or updated files. See also --force-update and notes below on export and --update.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-force-update">
<span class="sig-name descname"><span class="pre">--force-update</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-force-update" title="Link to this definition">¶</a></dt>
<dd><p>Only export new or updated files. Unlike --update, --force-update will re-export photos if their metadata has changed even if this would not otherwise trigger an export. See also --update and notes below on export and --update.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-update-errors">
<span class="sig-name descname"><span class="pre">--update-errors</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-update-errors" title="Link to this definition">¶</a></dt>
<dd><p>Update files that were previously exported but produced errors during export. For example, if a file produced an error with --exiftool due to bad metadata, this option will re-export the file and attempt to write the metadata again when used with --exiftool and --update. Without --update-errors, photos that were successfully exported but generated an error or warning during export will not be re-attempted if metadata has not changed. Must be used with --update.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-ignore-signature">
<span class="sig-name descname"><span class="pre">--ignore-signature</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-ignore-signature" title="Link to this definition">¶</a></dt>
<dd><p>When used with '--update', ignores file signature when updating files. This is useful if you have processed or edited exported photos changing the file signature (size &amp; modification date). In this case, '--update' would normally re-export the processed files but with '--ignore-signature', files which exist in the export directory will not be re-exported. If used with '--sidecar', '--ignore-signature' has the following behavior: 1) if the metadata (in Photos) that went into the sidecar did not change, the sidecar will not be updated; 2) if the metadata (in Photos) that went into the sidecar did change, a new sidecar is written but a new image file is not; 3) if a sidecar does not exist for the photo, a sidecar will be written whether or not the photo file was written or updated.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-only-new">
<span class="sig-name descname"><span class="pre">--only-new</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-only-new" title="Link to this definition">¶</a></dt>
<dd><p>If used with --update, ignores any previously exported files, even if missing from the export folder and only exports new files that haven't previously been exported.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-limit">
<span class="sig-name descname"><span class="pre">--limit</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;LIMIT&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-limit" title="Link to this definition">¶</a></dt>
<dd><p>Export at most LIMIT photos. Useful for testing. May be used with --update to export incrementally.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-dry-run">
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-dry-run" title="Link to this definition">¶</a></dt>
<dd><p>Dry run (test) the export but don't actually export any files; most useful with --verbose.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-export-as-hardlink">
<span class="sig-name descname"><span class="pre">--export-as-hardlink</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-export-as-hardlink" title="Link to this definition">¶</a></dt>
<dd><p>Hardlink files instead of copying them. Cannot be used with --exiftool which creates copies of the files with embedded EXIF data. Note: on APFS volumes, files are cloned when exporting giving many of the same advantages as hardlinks without having to use --export-as-hardlink.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-touch-file">
<span class="sig-name descname"><span class="pre">--touch-file</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-touch-file" title="Link to this definition">¶</a></dt>
<dd><p>Sets the file's modification time to match photo date.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-overwrite">
<span class="sig-name descname"><span class="pre">--overwrite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-overwrite" title="Link to this definition">¶</a></dt>
<dd><p>Overwrite existing files. Default behavior is to add (1), (2), etc to filename if file already exists. Use this with caution as it may create name collisions on export. (e.g. if two files happen to have the same name)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-retry">
<span class="sig-name descname"><span class="pre">--retry</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;RETRY&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-retry" title="Link to this definition">¶</a></dt>
<dd><p>Automatically retry export up to RETRY times if an error occurs during export.  This may be useful with network drives that experience intermittent errors.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-export-by-date">
<span class="sig-name descname"><span class="pre">--export-by-date</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-export-by-date" title="Link to this definition">¶</a></dt>
<dd><p>Automatically create output folders to organize photos by date created (e.g. DEST/2019/12/20/photoname.jpg).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-edited">
<span class="sig-name descname"><span class="pre">--skip-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-edited" title="Link to this definition">¶</a></dt>
<dd><p>Do not export edited version of photo if an edited version exists.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-original-if-edited">
<span class="sig-name descname"><span class="pre">--skip-original-if-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-original-if-edited" title="Link to this definition">¶</a></dt>
<dd><p>Do not export original if there is an edited version (exports only the edited version).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-bursts">
<span class="sig-name descname"><span class="pre">--skip-bursts</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-bursts" title="Link to this definition">¶</a></dt>
<dd><p>Do not export all associated burst images in the library if a photo is a burst photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-live">
<span class="sig-name descname"><span class="pre">--skip-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-live" title="Link to this definition">¶</a></dt>
<dd><p>Do not export the associated live video component of a live photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-raw">
<span class="sig-name descname"><span class="pre">--skip-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-raw" title="Link to this definition">¶</a></dt>
<dd><p>Do not export associated RAW image of a RAW+JPEG pair.  Note: this does not skip RAW photos if the RAW photo does not have an associated JPEG image (e.g. the RAW file was imported to Photos without a JPEG preview).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-uuid">
<span class="sig-name descname"><span class="pre">--skip-uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-uuid" title="Link to this definition">¶</a></dt>
<dd><p>Skip photos with UUID(s) during export. May be repeated to include multiple UUIDs.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-uuid-from-file">
<span class="sig-name descname"><span class="pre">--skip-uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-uuid-from-file" title="Link to this definition">¶</a></dt>
<dd><p>Skip photos with UUID(s) loaded from FILE. Format is a single UUID per line.  Lines preceded with # are ignored.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-current-name">
<span class="sig-name descname"><span class="pre">--current-name</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-current-name" title="Link to this definition">¶</a></dt>
<dd><p>Use photo's current filename instead of original filename for export.  Note: Starting with Photos 5, all photos are renamed upon import.  By default, photos are exported with the the original name they had before import.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-convert-to-jpeg">
<span class="sig-name descname"><span class="pre">--convert-to-jpeg</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-convert-to-jpeg" title="Link to this definition">¶</a></dt>
<dd><p>Convert all non-JPEG images (e.g. RAW, HEIC, PNG, etc) to JPEG upon export. Note: does not convert the RAW component of a RAW+JPEG pair as the associated JPEG image will be exported. You can use --skip-raw to skip exporting the associated RAW image of a RAW+JPEG pair. See also --jpeg-quality and --jpeg-ext. Only works if your Mac has a GPU (thus may not work on virtual machines).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-jpeg-quality">
<span class="sig-name descname"><span class="pre">--jpeg-quality</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;jpeg_quality&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-jpeg-quality" title="Link to this definition">¶</a></dt>
<dd><p>Value in range 0.0 to 1.0 to use with --convert-to-jpeg. A value of 1.0 specifies best quality, a value of 0.0 specifies maximum compression. Defaults to 1.0</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-fix-orientation">
<span class="sig-name descname"><span class="pre">--fix-orientation</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-fix-orientation" title="Link to this definition">¶</a></dt>
<dd><p>Automatically fix image orientation in exported photos to match orientation in Photos database. Requires exiftool be installed and in the path. This is useful mainly for iPhoto libraries. When an image is rotated in iPhoto, the image orientation is not actually changed, instead the image is tagged with an orientation value in the iPhoto database. This means that when the image is exported, the orientation may not be correct. This option will read the EXIF orientation data and fix the image's orientation if necessary. If used with Photos libraries, this option will result in the original image also being adjusted upon export.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-preview">
<span class="sig-name descname"><span class="pre">--preview</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-preview" title="Link to this definition">¶</a></dt>
<dd><p>Export preview image generated by Photos. This is a lower-resolution image used by Photos to quickly preview the image. See also --preview-suffix and --preview-if-missing.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-preview-if-missing">
<span class="sig-name descname"><span class="pre">--preview-if-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-preview-if-missing" title="Link to this definition">¶</a></dt>
<dd><p>Export preview image generated by Photos if the actual photo file is missing from the library. This may be helpful if photos were not copied to the Photos library and the original photo is missing. See also --preview-suffix and --preview.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-preview-suffix">
<span class="sig-name descname"><span class="pre">--preview-suffix</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SUFFIX&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-preview-suffix" title="Link to this definition">¶</a></dt>
<dd><p>Optional suffix template for naming preview photos.  Default name for preview photos is in form 'photoname_preview.ext'. For example, with '--preview-suffix _low_res', the preview photo would be named 'photoname_low_res.ext'.  The default suffix is '_preview'. Multi-value templates (see Templating System) are not permitted with --preview-suffix. See also --preview and --preview-if-missing.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-download-missing">
<span class="sig-name descname"><span class="pre">--download-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-download-missing" title="Link to this definition">¶</a></dt>
<dd><p>Attempt to download missing photos from iCloud. The current implementation uses Applescript to interact with Photos to export the photo which will force Photos to download from iCloud if the photo does not exist on disk.  This will be slow and will require internet connection. This obviously only works if the Photos library is synched to iCloud.  Note: --download-missing does not currently export all burst images; only the primary photo will be exported--associated burst images will be skipped.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-export-aae">
<span class="sig-name descname"><span class="pre">--export-aae</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-export-aae" title="Link to this definition">¶</a></dt>
<dd><p>Also export an adjustments file detailing edits made to the original. The resulting file is named photoname.AAE. Note that to import these files back to Photos succesfully, you also need to export the edited photo and match the filename format Photos.app expects: --filename 'IMG_{edited_version?E,}{id:04d}' --edited-suffix ''</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-sidecar">
<span class="sig-name descname"><span class="pre">--sidecar</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FORMAT&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-sidecar" title="Link to this definition">¶</a></dt>
<dd><p>Create sidecar for each photo exported; valid FORMAT values: xmp, json, exiftool; --sidecar xmp: create XMP sidecar used by Digikam, Adobe Lightroom, etc. The sidecar file is named in format photoname.ext.xmp The XMP sidecar exports the following tags: Description, Title, Keywords/Tags, Subject (set to Keywords + PersonInImage), PersonInImage, CreateDate, ModifyDate, GPSLongitude, Face Regions (Metadata Working Group and Microsoft Photo).
--sidecar json: create JSON sidecar useable by exiftool (<a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>) The sidecar file can be used to apply metadata to the file with exiftool, for example: &quot;exiftool -j=photoname.jpg.json photoname.jpg&quot; The sidecar file is named in format photoname.ext.json; format includes tag groups (equivalent to running 'exiftool -G -j').
--sidecar exiftool: create JSON sidecar compatible with output of 'exiftool -j'. Unlike '--sidecar json', '--sidecar exiftool' does not export tag groups. Sidecar filename is in format photoname.ext.json; For a list of tags exported in the JSON and exiftool sidecar, see '--exiftool'. See also '--ignore-signature'.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>xmp | json | exiftool</p>
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-sidecar-drop-ext">
<span class="sig-name descname"><span class="pre">--sidecar-drop-ext</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-sidecar-drop-ext" title="Link to this definition">¶</a></dt>
<dd><p>Drop the photo's extension when naming sidecar files. By default, sidecar files are named in format 'photo_filename.photo_ext.sidecar_ext', e.g. 'IMG_1234.JPG.xmp'. Use '--sidecar-drop-ext' to ignore the photo extension. Resulting sidecar files will have name in format 'IMG_1234.xmp'. Warning: this may result in sidecar filename collisions if there are files of different types but the same name in the output directory, e.g. 'IMG_1234.JPG' and 'IMG_1234.MOV'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-sidecar-template">
<span class="sig-name descname"><span class="pre">--sidecar-template</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;MAKO_TEMPLATE_FILE</span> <span class="pre">SIDECAR_FILENAME_TEMPLATE</span> <span class="pre">OPTIONS&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-sidecar-template" title="Link to this definition">¶</a></dt>
<dd><p>Create a custom sidecar file for each photo exported with user provided Mako template (MAKO_TEMPLATE_FILE). MAKO_TEMPLATE_FILE must be a valid Mako template (see <a class="reference external" href="https://www.makotemplates.org/">https://www.makotemplates.org/</a>). The template will passed the following variables: photo: PhotoInfo object for the photo being exported, sidecar_path: pathlib.Path object for the path to the sidecar being written, photo_path: pathlib.Path object for the path to the exported photo, description: description/caption of the photo, including results of --description-template, keywords: keywords associated with the photo, including results of options like --person-keyword, persons: persons in the photo, including results of --exiftool-merge-persons, subjects: equivalent to keywords, latlon: latitude &amp; longitude of photo as a tuple, rating: rating of photo including result of --favorite-rating, extension: file extension of the exported photo, version: current osxphotos version. SIDECAR_FILENAME_TEMPLATE must be a valid template string (see Templating System in help) which will be rendered to generate the filename of the sidecar file. The '{filepath}' template variable may be used in the SIDECAR_FILENAME_TEMPLATE to refer to the filename of the photo being exported. OPTIONS is a comma-separated list of strings providing additional options to the template. Valid options are: write_skipped, strip_whitespace, strip_lines, skip_zero, catch_errors, none. write_skipped will cause the sidecar file to be written even if the photo is skipped during export. If write_skipped is not passed as an option, the sidecar file will not be written if the photo is skipped during export. strip_whitespace and strip_lines indicate whether or not to strip whitespace and blank lines, respectively, from the resulting sidecar file. skip_zero causes the sidecar file to be skipped if the rendered template is zero-length. catch_errors causes errors in the template to be caught and logged but not raised. Without catch_errors, osxphotos will abort the export if an error occurs in the template. For example, to create a sidecar file with extension .xmp using a template file named 'sidecar.mako' and write a sidecar for skipped photos and strip blank lines but not whitespace: '--sidecar-template sidecar.mako '{filepath}.xmp' write_skipped,strip_lines'. To do the same but to drop the photo extension from the sidecar filename: '--sidecar-template sidecar.mako &quot;{filepath.parent}/{filepath.stem}.xmp&quot; write_skipped,strip_lines'. If you are not passing any options, you must pass 'none' as the last argument to --sidecar-template: '--sidecar-template sidecar.mako &quot;{filepath}.xmp&quot; none'. For an example Mako file see <a class="reference external" href="https://raw.githubusercontent.com/RhetTbull/osxphotos/main/examples/custom_sidecar.mako">https://raw.githubusercontent.com/RhetTbull/osxphotos/main/examples/custom_sidecar.mako</a></p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exiftool">
<span class="sig-name descname"><span class="pre">--exiftool</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-exiftool" title="Link to this definition">¶</a></dt>
<dd><p>Use exiftool to write metadata directly to exported photos. To use this option, exiftool must be installed and in the path.  exiftool may be installed from <a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>.  Cannot be used with --export-as-hardlink.  Writes the following metadata: EXIF:ImageDescription, XMP:Description (see also --description-template); XMP:Title; XMP:TagsList, IPTC:Keywords, XMP:Subject (see also --keyword-template, --person-keyword, --album-keyword); XMP:PersonInImage; EXIF:GPSLatitudeRef; EXIF:GPSLongitudeRef; EXIF:GPSLatitude; EXIF:GPSLongitude; EXIF:GPSPosition; EXIF:DateTimeOriginal; EXIF:OffsetTimeOriginal; EXIF:ModifyDate (see --ignore-date-modified); IPTC:DateCreated; IPTC:TimeCreated; (video files only): QuickTime:CreationDate; QuickTime:CreateDate; QuickTime:ModifyDate (see also --ignore-date-modified); QuickTime:GPSCoordinates; UserData:GPSCoordinates.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exiftool-path">
<span class="sig-name descname"><span class="pre">--exiftool-path</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXIFTOOL_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-exiftool-path" title="Link to this definition">¶</a></dt>
<dd><p>Optionally specify path to exiftool; if not provided, will look for exiftool in $PATH.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exiftool-option">
<span class="sig-name descname"><span class="pre">--exiftool-option</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;OPTION&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-exiftool-option" title="Link to this definition">¶</a></dt>
<dd><p>Optional flag/option to pass to exiftool when using --exiftool. For example, &quot;--exiftool-option '-m'&quot; to ignore minor warnings. Specify these as you would on the exiftool command line. See exiftool docs at <a class="reference external" href="https://exiftool.org/exiftool_pod.html">https://exiftool.org/exiftool_pod.html</a> for full list of options. More than one option may be specified by repeating the option, e.g. --exiftool-option '-m' --exiftool-option '-F'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exiftool-merge-keywords">
<span class="sig-name descname"><span class="pre">--exiftool-merge-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-exiftool-merge-keywords" title="Link to this definition">¶</a></dt>
<dd><p>Merge any keywords found in the original file with keywords used for '--exiftool' and '--sidecar'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exiftool-merge-persons">
<span class="sig-name descname"><span class="pre">--exiftool-merge-persons</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-exiftool-merge-persons" title="Link to this definition">¶</a></dt>
<dd><p>Merge any persons found in the original file with persons used for '--exiftool' and '--sidecar'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-favorite-rating">
<span class="sig-name descname"><span class="pre">--favorite-rating</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-favorite-rating" title="Link to this definition">¶</a></dt>
<dd><p>When used with --exiftool or --sidecar, set XMP:Rating=5 for photos marked as Favorite and XMP:Rating=0 for non-Favorites. If not specified, XMP:Rating is not set.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-ignore-date-modified">
<span class="sig-name descname"><span class="pre">--ignore-date-modified</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-ignore-date-modified" title="Link to this definition">¶</a></dt>
<dd><p>If used with --exiftool or --sidecar, will ignore the photo modification date and set EXIF:ModifyDate to EXIF:DateTimeOriginal; this is consistent with how Photos handles the EXIF:ModifyDate tag.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-person-keyword">
<span class="sig-name descname"><span class="pre">--person-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-person-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Use person in image as keyword/tag when exporting metadata.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-album-keyword">
<span class="sig-name descname"><span class="pre">--album-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-album-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Use album name as keyword/tag when exporting metadata.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-keyword-template">
<span class="sig-name descname"><span class="pre">--keyword-template</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-keyword-template" title="Link to this definition">¶</a></dt>
<dd><p>For use with --exiftool, --sidecar; specify a template string to use as keyword in the form '{name,DEFAULT}' This is the same format as --directory.  For example, if you wanted to add the full path to the folder and album photo is contained in as a keyword when exporting you could specify --keyword-template &quot;{folder_album}&quot; You may specify more than one template, for example --keyword-template &quot;{folder_album}&quot; --keyword-template &quot;{created.year}&quot;. See '--replace-keywords' and Templating System below.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-replace-keywords">
<span class="sig-name descname"><span class="pre">--replace-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-replace-keywords" title="Link to this definition">¶</a></dt>
<dd><p>Replace keywords with any values specified with --keyword-template. By default, --keyword-template will add keywords to any keywords already associated with the photo.  If --replace-keywords is specified, values from --keyword-template will replace any existing keywords instead of adding additional keywords.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-description-template">
<span class="sig-name descname"><span class="pre">--description-template</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-description-template" title="Link to this definition">¶</a></dt>
<dd><p>For use with --exiftool, --sidecar; specify a template string to use as description in the form '{name,DEFAULT}' This is the same format as --directory.  For example, if you wanted to append 'exported with osxphotos on [today's date]' to the description, you could specify --description-template &quot;{descr} exported with osxphotos on {today.date}&quot; See Templating System below.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-finder-tag-template">
<span class="sig-name descname"><span class="pre">--finder-tag-template</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-finder-tag-template" title="Link to this definition">¶</a></dt>
<dd><p>Set MacOS Finder tags to TEMPLATE. These tags can be searched in the Finder or Spotlight with '<a class="reference external" href="tag:tagname">tag:tagname</a>' format. For example, '--finder-tag-template &quot;{label}&quot;' to set Finder tags to photo labels. You may specify multiple TEMPLATE values by using '--finder-tag-template' multiple times. See also '--finder-tag-keywords and Extended Attributes below.'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-finder-tag-keywords">
<span class="sig-name descname"><span class="pre">--finder-tag-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-finder-tag-keywords" title="Link to this definition">¶</a></dt>
<dd><p>Set MacOS Finder tags to keywords; any keywords specified via '--keyword-template', '--person-keyword', etc. will also be used as Finder tags. See also '--finder-tag-template and Extended Attributes below.'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-xattr-template">
<span class="sig-name descname"><span class="pre">--xattr-template</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ATTRIBUTE</span> <span class="pre">TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-xattr-template" title="Link to this definition">¶</a></dt>
<dd><p>Set extended attribute ATTRIBUTE to TEMPLATE value. Valid attributes are: 'authors', 'comment', 'copyright', 'creator', 'description', 'findercomment', 'headline', 'participants', 'projects', 'starrating', 'subject', 'title', 'version'. For example, to set Finder comment to the photo's title and description: '--xattr-template findercomment &quot;{title}; {descr}&quot; See Extended Attributes below for additional details on this option.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-directory">
<span class="sig-name descname"><span class="pre">--directory</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DIRECTORY&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-directory" title="Link to this definition">¶</a></dt>
<dd><p>Optional template for specifying name of output directory in the form '{name,DEFAULT}'. See below for additional details on templating system.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-filename">
<span class="sig-name descname"><span class="pre">--filename</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILENAME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-filename" title="Link to this definition">¶</a></dt>
<dd><p>Optional template for specifying name of output file in the form '{name,DEFAULT}'. File extension will be added automatically--do not include an extension in the FILENAME template. See below for additional details on templating system.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-jpeg-ext">
<span class="sig-name descname"><span class="pre">--jpeg-ext</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXTENSION&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-jpeg-ext" title="Link to this definition">¶</a></dt>
<dd><p>Specify file extension for JPEG files. Photos uses .jpeg for edited images but many images are imported with .jpg or .JPG which can result in multiple different extensions used for JPEG files upon export.  Use --jpeg-ext to specify a single extension to use for all exported JPEG images. Valid values are jpeg, jpg, JPEG, JPG; e.g. '--jpeg-ext jpg' to use '.jpg' for all JPEGs.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>jpeg | jpg | JPEG | JPG</p>
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-strip">
<span class="sig-name descname"><span class="pre">--strip</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-strip" title="Link to this definition">¶</a></dt>
<dd><p>Optionally strip leading and trailing whitespace from any rendered templates. For example, if --filename template is &quot;{title,} {original_name}&quot; and image has no title, resulting file would have a leading space but if used with --strip, this will be removed.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-edited-suffix">
<span class="sig-name descname"><span class="pre">--edited-suffix</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SUFFIX&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-edited-suffix" title="Link to this definition">¶</a></dt>
<dd><p>Optional suffix template for naming edited photos.  Default name for edited photos is in form 'photoname_edited.ext'. For example, with '--edited-suffix _bearbeiten', the edited photo would be named 'photoname_bearbeiten.ext'.  The default suffix is '_edited'. Multi-value templates (see Templating System) are not permitted with --edited-suffix.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-original-suffix">
<span class="sig-name descname"><span class="pre">--original-suffix</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SUFFIX&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-original-suffix" title="Link to this definition">¶</a></dt>
<dd><p>Optional suffix template for naming original photos.  Default name for original photos is in form 'filename.ext'. For example, with '--original-suffix _original', the original photo would be named 'filename_original.ext'.  The default suffix is '' (no suffix). Multi-value templates (see Templating System) are not permitted with --original-suffix.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-use-photos-export">
<span class="sig-name descname"><span class="pre">--use-photos-export</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-use-photos-export" title="Link to this definition">¶</a></dt>
<dd><p>Force the use of AppleScript or PhotoKit to export even if not missing (see also '--download-missing' and '--use-photokit').</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-use-photokit">
<span class="sig-name descname"><span class="pre">--use-photokit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-use-photokit" title="Link to this definition">¶</a></dt>
<dd><p>Use with '--download-missing' or '--use-photos-export' to use direct Photos interface instead of AppleScript to export. Highly experimental alpha feature; does not work with iTerm2 (use with Terminal.app). This is faster and more reliable than the default AppleScript interface.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-report">
<span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REPORT_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-report" title="Link to this definition">¶</a></dt>
<dd><p>Write a report of all files that were exported. The extension of the report filename will be used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). REPORT_FILE may be a template string (see Templating System), for example, --report 'export_{today.date}.csv' will write a CSV report file named with today's date. See also --append.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-append">
<span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-append" title="Link to this definition">¶</a></dt>
<dd><p>If used with --report, add data to existing report file instead of overwriting it. See also --report.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-cleanup">
<span class="sig-name descname"><span class="pre">--cleanup</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-cleanup" title="Link to this definition">¶</a></dt>
<dd><p>Cleanup export directory by deleting any files which were not included in this export set. For example, photos which had previously been exported and were subsequently deleted in Photos. WARNING: --cleanup will delete <em>any</em> files in the export directory that were not exported by osxphotos, for example, your own scripts or other files.  Be sure this is what you intend before using --cleanup.  Use --dry-run with --cleanup first if you're not certain. To prevent files not generated by osxphotos from being deleted, you may specify one or more rules in a file named '.osxphotos_keep' in the export directory. This file uses the same format as a .gitignore file and should contain one rule per line; lines starting with a '#' will be ignored. Reference <a class="reference external" href="https://git-scm.com/docs/gitignore#_pattern_format">https://git-scm.com/docs/gitignore#_pattern_format</a> for details. In addition to the standard .gitignore rules, the rules may also be the absolute path to a file or directory. For example if export destination is '/Volumes/Photos' and you want to keep all '.txt' files, in the top level of the export directory, you can specify '/<em>.txt' in the .osxphotos_keep file. If you want to keep all '.txt' files in the export directory and all subdirectories, you can specify '*</em>/<a href="#id1"><span class="problematic" id="id2">*</span></a>.txt'. If present, the .osxphotos_keep file will be read after the export is completed and any rules found in the file will be added to the list of rules to keep. See also --keep.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-keep">
<span class="sig-name descname"><span class="pre">--keep</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;KEEP_RULE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-keep" title="Link to this definition">¶</a></dt>
<dd><p>When used with --cleanup, prevents file or directory matching KEEP_RULE from being deleted when cleanup is run. Use this if there are files in the export directory that you don't want to be deleted when --cleanup is run. KEEP_RULE follows the same format rules a .gitignore file. Reference <a class="reference external" href="https://git-scm.com/docs/gitignore#_pattern_format">https://git-scm.com/docs/gitignore#_pattern_format</a> for details. In addition to the standard .gitignore rules, KEEP_RULE may also be the absolute path to a file or directory. For example if export destination is '/Volumes/Photos' and you want to keep all '.txt' files, in the top level of the export directory, you can specify '--keep &quot;<em>.txt&quot;. If you want to keep all '.txt' files in the export directory and all subdirectories, you can specify '--keep &quot;*</em>/<a href="#id3"><span class="problematic" id="id4">*</span></a>.txt&quot;'. If wild card is used, KEEP_RULE must be enclosed in quotes to prevent the shell from expanding the wildcard. --keep may be repeated to keep additional files/directories. Rules may also be included in a file named '.osxphotos_keep' in the export directory. If present, this file will be read after the export is completed and any rules found in the file will be added to the list of rules to keep. This file uses the same format as a .gitignore file and should contain one rule per line; lines starting with a '#' will be ignored.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-add-exported-to-album">
<span class="sig-name descname"><span class="pre">--add-exported-to-album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-add-exported-to-album" title="Link to this definition">¶</a></dt>
<dd><p>Add all exported photos to album ALBUM in Photos. Album ALBUM will be created if it doesn't exist.  All exported photos will be added to this album. This only works if the Photos library being exported is the last-opened (default) library in Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-add-skipped-to-album">
<span class="sig-name descname"><span class="pre">--add-skipped-to-album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-add-skipped-to-album" title="Link to this definition">¶</a></dt>
<dd><p>Add all skipped photos to album ALBUM in Photos. Album ALBUM will be created if it doesn't exist.  All skipped photos will be added to this album. This only works if the Photos library being exported is the last-opened (default) library in Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-add-missing-to-album">
<span class="sig-name descname"><span class="pre">--add-missing-to-album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-add-missing-to-album" title="Link to this definition">¶</a></dt>
<dd><p>Add all missing photos to album ALBUM in Photos. Album ALBUM will be created if it doesn't exist.  All missing photos will be added to this album. This only works if the Photos library being exported is the last-opened (default) library in Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-post-command">
<span class="sig-name descname"><span class="pre">--post-command</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CATEGORY</span> <span class="pre">COMMAND&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-post-command" title="Link to this definition">¶</a></dt>
<dd><p>Run COMMAND on exported files of category CATEGORY.  CATEGORY can be one of: exported, new, updated, skipped, missing, exif_updated, touched, converted_to_jpeg, sidecar_json_written, sidecar_json_skipped, sidecar_exiftool_written, sidecar_exiftool_skipped, sidecar_xmp_written, sidecar_xmp_skipped, error. COMMAND is an osxphotos template string, for example: '--post-command exported &quot;echo {filepath|shell_quote} &gt;&gt; {export_dir}/exported.txt&quot;', which appends the full path of all exported files to the file 'exported.txt'. You can run more than one command by repeating the '--post-command' option with different arguments. See also --post-command-error and --post-function.See Post Command below.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-post-command-error">
<span class="sig-name descname"><span class="pre">--post-command-error</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ACTION&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-post-command-error" title="Link to this definition">¶</a></dt>
<dd><p>Specify either 'continue' or 'break' for ACTION to control behavior when a post-command fails. If 'continue', osxphotos will log the error and continue processing. If 'break', osxphotos will stop processing any additional --post-command commands for the current photo but will continue with the export. Without --post-command-error, osxphotos will abort the export if a post-command encounters an error.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>continue | break</p>
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-post-function">
<span class="sig-name descname"><span class="pre">--post-function</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;filename.py:function&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-post-function" title="Link to this definition">¶</a></dt>
<dd><p>Run function on exported files. Use this in format: --post-function filename.py:function where filename.py is a python file you've created and function is the name of the function in the python file you want to call.  The function will be passed information about the photo that's been exported and a list of all exported files associated with the photo. You can run more than one function by repeating the '--post-function' option with different arguments. You may also specify a post function using a URL in format --post-function 'https://path/to/module.py:function' See Post Function below.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exportdb">
<span class="sig-name descname"><span class="pre">--exportdb</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXPORTDB_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-exportdb" title="Link to this definition">¶</a></dt>
<dd><p>Specify alternate path for database file which stores state information for export and --update. If --exportdb is not specified, export database will be saved to '.osxphotos_export.db' in the export directory.  If --exportdb is specified, it will be saved to the specified file.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-ramdb">
<span class="sig-name descname"><span class="pre">--ramdb</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-ramdb" title="Link to this definition">¶</a></dt>
<dd><p>Copy export database to memory during export; will improve performance when exporting over a network or slow disk. Note: osxphotos will automatically detect if export database is on a network volume and force use of --ramdb. See also --exportdb to specifiy an alternate location for the export database and also --checkpoint.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-checkpoint">
<span class="sig-name descname"><span class="pre">--checkpoint</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;NUMBER_OF_PHOTOS&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-checkpoint" title="Link to this definition">¶</a></dt>
<dd><p>When used with --ramdb, periodically save the export database back to disk after processing NUMBER_OF_PHOTOS. When using --ramdb, the export database will be automatically saved if there is a crash or interrupt thus you do not generally need to specify --checkpoint and doing so may slow down the export if your export database is large. This is an advanced feature for those who need to fine-tune the behavior of osxphotos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-F">
<span id="cmdoption-osxphotos-export-ignore-exportdb"></span><span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-exportdb</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-F" title="Link to this definition">¶</a></dt>
<dd><ol class="arabic simple">
<li><p>If exporting to a directory that already contains an export database and --update is not specified, do not prompt to continue but instead continue the export. Normally, if you export to a directory that already contains an export database and do not specify --update, osxphotos will prompt you to continue. This is because you may be inadvertently merging two export sets. Use --ignore-exportdb to skip this prompt and continue the export. The resulting export database will contain the combined state of both export sets. Short option is '-F' (mnemonic: force export). 2) For advanced use: when used with --update, --ignore-exportdb will skip searching for export database files in the parent or child of the export directory; thus avoiding what could be a time comsuming search. 3) See also --update.</p></li>
</ol>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-exportdb">
<span class="sig-name descname"><span class="pre">--no-exportdb</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-exportdb" title="Link to this definition">¶</a></dt>
<dd><p>Do not create an export database. This exports all photos in the export set but does not save any state information in the osxphotos export database. If you use --no-exportdb, you will not be able to use --update on subsequent exports. It is recommended that you do not use this option unless you are certain you understand the implications.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-tmpdir">
<span class="sig-name descname"><span class="pre">--tmpdir</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DIR&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-tmpdir" title="Link to this definition">¶</a></dt>
<dd><p>Specify alternate temporary directory. Default is system temporary directory. osxphotos needs to create a number of temporary files during export. In some cases, particularly if the Photos library is on an APFS volume that is not the system volume, osxphotos may run faster if you specify a temporary directory on the same volume as the Photos library.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-alt-copy">
<span class="sig-name descname"><span class="pre">--alt-copy</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-alt-copy" title="Link to this definition">¶</a></dt>
<dd><p>Use alternate copy method that may be more reliable for some network attached storage (NAS) devices. Use --alt-copy if you experience problems exporting to a NAS device or SMB volume. Unlike the default copy method, --alt-copy does not support copy-on-write on APFS volumes nor does it preserve filesystem metadata.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-alt-db">
<span class="sig-name descname"><span class="pre">--alt-db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-alt-db" title="Link to this definition">¶</a></dt>
<dd><p>Specify alternate path to Photos library database. This is an advanced feature you probably don't need. This may be useful when exporting from a library on a very slow external disk. In this case, you could copy the '/database' folder from the Photos library to the internal diskand use '--alt-db' to specify the path to the database file on the internal disk. then use '--library' to specify the path to the Photos library root on the external disk. For example: '--library /Volumes/ExternalDisk/Photos.photoslibrary --alt-db /path/to/database/Photos.sqlite'</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-load-config">
<span class="sig-name descname"><span class="pre">--load-config</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CONFIG_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-load-config" title="Link to this definition">¶</a></dt>
<dd><p>Load options from file as written with --save-config. This allows you to save a complex export command to file for later reuse. For example: 'osxphotos export &lt;lots of options here&gt; --save-config osxphotos.toml' then  'osxphotos export /path/to/export --load-config osxphotos.toml'. If any other command line options are used in conjunction with --load-config, they will override the corresponding values in the config file.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-save-config">
<span class="sig-name descname"><span class="pre">--save-config</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CONFIG_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-save-config" title="Link to this definition">¶</a></dt>
<dd><p>Save options to file for use with --load-config. File format is TOML. See also --config-only.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-config-only">
<span class="sig-name descname"><span class="pre">--config-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-config-only" title="Link to this definition">¶</a></dt>
<dd><p>If specified, saves the config file but does not export any files; must be used with --save-config.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-print">
<span class="sig-name descname"><span class="pre">--print</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-print" title="Link to this definition">¶</a></dt>
<dd><p>Render TEMPLATE string for each photo being exported and print to stdout. TEMPLATE is an osxphotos template string. This may be useful for creating custom reports, etc. TEMPLATE will be printed after the photo is exported or skipped. May be repeated to print multiple template strings.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-theme">
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-theme" title="Link to this definition">¶</a></dt>
<dd><p>Specify the color theme to use for output. Valid themes are 'dark', 'light', 'mono', and 'plain'. Defaults to 'dark' or 'light' depending on system dark mode setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>dark | light | mono | plain</p>
</dd>
</dl>
</dd></dl>

<p>Export</p>
<p>When exporting photos, osxphotos creates a database in the top-level export folder called
'.osxphotos_export.db'.  This database preserves state information used for determining which files need to be
updated when run with --update.  It is recommended that if you later move the export folder tree you also move
the database file.</p>
<p>The --update option will only copy new or updated files from the library to the export folder.  If a file is
changed in the export folder (for example, you edited the exported image), osxphotos will detect this as a
difference and re-export the original image from the library thus overwriting the changes.  If using --update,
the exported library should be treated as a backup, not a working copy where you intend to make changes. If
you do edit or process the exported files and do not want them to be overwritten withsubsequent --update, use
--ignore-signature which will match filename but not file signature when exporting.</p>
<p>Note: The number of files reported for export and the number actually exported may differ due to live photos,
associated raw images, and edited photos which are reported in the total photos exported.</p>
<p>Implementation note: To determine which files need to be updated, osxphotos stores file signature information
in the '.osxphotos_export.db' database. The signature includes size, modification time, and filename.  In
order to minimize run time, --update does not do a full comparison (diff) of the files nor does it compare
hashes of the files.  In normal usage, this is sufficient for updating the library. You can always run export
without the --update option to re-export the entire library thus rebuilding the '.osxphotos_export.db'
database.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>                                         Extended Attributes

Some options (currently &#39;--finder-tag-template&#39;, &#39;--finder-tag-keywords&#39;, &#39;-xattr-template&#39;) write
additional metadata accessible by Spotlight to facilitate searching.      For example, --finder-tag-
keyword writes all keywords (including any specified by &#39;--keyword-template&#39;     or other options) to
Finder tags that are searchable in Spotlight using the syntax: &#39;tag:tagname&#39;.     For example, if you have
images with keyword &quot;Travel&quot; then using &#39;--finder-tag-keywords&#39; you could quickly     find those images in
the Finder by typing &#39;tag:Travel&#39; in the Spotlight search bar.     Finder tags are written to the
&#39;com.apple.metadata:\_kMDItemUserTags&#39; extended attribute.     Unlike EXIF metadata, extended attributes do
not modify the actual file;     the metadata is written to extended attributes associated with the file
and the Spotlight metadata database.      Most cloud storage services do not synch extended attributes.
Dropbox does sync them and any changes to a file&#39;s extended attributes     will cause Dropbox to re-sync
the files.

The following attributes may be used with &#39;--xattr-template&#39;:
</pre></div>
</div>
<p>Attribute      Description
authors        kMDItemAuthors; com.apple.metadata:kMDItemAuthors; The author, or authors, of the contents of</p>
<blockquote>
<div><p>the file.; list of strings</p>
</div></blockquote>
<dl class="simple">
<dt>comment        kMDItemComment; com.apple.metadata:kMDItemComment; A comment related to the file. This</dt><dd><p>differs from the Finder comment, kMDItemFinderComment.; string</p>
</dd>
<dt>copyright      kMDItemCopyright; com.apple.metadata:kMDItemCopyright; The copyright owner of the file</dt><dd><p>contents.; string</p>
</dd>
<dt>creator        kMDItemCreator; com.apple.metadata:kMDItemCreator; Application used to create the document</dt><dd><p>content (for example &quot;Word&quot;, &quot;Pages&quot;, and so on).; string</p>
</dd>
</dl>
<p>description    kMDItemDescription; com.apple.metadata:kMDItemDescription; A description of the content of</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>the resource. The description may include an abstract, table of contents, reference to a
graphical representation of content or a free-text account of the content.; string
</pre></div>
</div>
<dl class="simple">
<dt>findercomment  kMDItemFinderComment; com.apple.metadata:kMDItemFinderComment; Finder comments for this</dt><dd><p>file.; string</p>
</dd>
<dt>headline       kMDItemHeadline; com.apple.metadata:kMDItemHeadline; A publishable entry providing a synopsis</dt><dd><p>of the contents of the file. For example, &quot;Apple Introduces the iPod Photo&quot;.; string</p>
</dd>
<dt>participants   kMDItemParticipants; com.apple.metadata:kMDItemParticipants; The list of people who are</dt><dd><p>visible in an image or movie or written about in a document.; list of strings</p>
</dd>
</dl>
<p>projects       kMDItemProjects; com.apple.metadata:kMDItemProjects; The list of projects that this file is</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>part of. For example, if you were working on a movie all of the files could be marked as
belonging to the project &quot;My Movie&quot;.; list of strings
</pre></div>
</div>
<dl class="simple">
<dt>starrating     kMDItemStarRating; com.apple.metadata:kMDItemStarRating; User rating of this item. For</dt><dd><p>example, the stars rating of an iTunes track.; number</p>
</dd>
</dl>
<p>subject        kMDItemSubject; com.apple.metadata:kMDItemSubject; Subject of the this item.; string
title          kMDItemTitle; com.apple.metadata:kMDItemTitle; The title of the file. For example, this could</p>
<blockquote>
<div><p>be the title of a document, the name of a song, or the subject of an email message.; string</p>
</div></blockquote>
<p>version        kMDItemVersion; com.apple.metadata:kMDItemVersion; The version number of this file.; string</p>
<p>For additional information on extended attributes see:
<a class="reference external" href="https://developer.apple.com/documentation/coreservices/file_metadata/mditem/common_metadata_attribute_keys">https://developer.apple.com/documentation/coreservices/file_metadata/mditem/common_metadata_attribute_keys</a></p>
<blockquote>
<div><p>Templating System</p>
</div></blockquote>
<p>The templating system converts one or template statements, written in osxphotos metadata templating language,
to one or more rendered values using information from the photo being processed.</p>
<p>In its simplest form, a template statement has the form: &quot;{template_field}&quot;, for example &quot;{title}&quot; which would
resolve to the title of the photo.</p>
<p>Template statements may contain one or more modifiers.  The full syntax is:</p>
<p>&quot;pretext{delim+template_field:subfield(field_arg)|filter[find,replace]
conditional&amp;combine_value?bool_value,default}posttext&quot;</p>
<p>Template statements are white-space sensitive meaning that white space (spaces, tabs) changes the meaning of
the template statement.</p>
<p>pretext and posttext are free form text.  For example, if a photo has title &quot;My Photo Title&quot; the template
statement &quot;The title of the photo is {title}&quot;, resolves to &quot;The title of the photo is My Photo Title&quot;.  The
pretext in this example is &quot;The title if the photo is &quot; and the template_field is {title}.</p>
<p>delim: optional delimiter string to use when expanding multi-valued template values in-place</p>
<p>+: If present before template name, expands the template in place.  If delim not provided, values are joined
with no delimiter.</p>
<p>e.g. if Photo keywords are [&quot;foo&quot;,&quot;bar&quot;]:</p>
<blockquote>
<div><ul class="simple">
<li><p>&quot;{keyword}&quot; renders to &quot;foo&quot;, &quot;bar&quot;</p></li>
<li><p>&quot;{,+keyword}&quot; renders to: &quot;foo,bar&quot;</p></li>
<li><p>&quot;{; +keyword}&quot; renders to: &quot;foo; bar&quot;</p></li>
<li><p>&quot;{+keyword}&quot; renders to &quot;foobar&quot;</p></li>
</ul>
</div></blockquote>
<p>template_field: The template field to resolve.  See Template Substitutions for full list of template fields.</p>
<dl class="field-list simple">
<dt class="field-odd">subfield<span class="colon">:</span></dt>
<dd class="field-odd"><p>Some templates have sub-fields, For example, {exiftool:IPTC:Make}; the template_field is exiftool</p>
</dd>
</dl>
<p>and the sub-field is IPTC:Make.</p>
<p>(field_arg): optional arguments to pass to the field; for example, with {folder_album} this is used to pass
the path separator used for joining folders and albums when rendering the field (default is &quot;/&quot; for
{folder_album}).</p>
<p><a href="#id31"><span class="problematic" id="id32">|filter: You may optionally append one or more filter commands to the end of the template field using the
vertical pipe ('|</span></a>') symbol.  Filters may be combined, separated by '|' as in: {keyword|capitalize|parens}.</p>
<p>Valid filters are:</p>
<blockquote>
<div><ul>
<li><p>lower: Convert value to lower case, e.g. 'Value' =&gt; 'value'.</p></li>
<li><p>upper: Convert value to upper case, e.g. 'Value' =&gt; 'VALUE'.</p></li>
<li><p>strip: Strip whitespace from beginning/end of value, e.g. ' Value ' =&gt; 'Value'.</p></li>
<li><p>titlecase: Convert value to title case, e.g. 'my value' =&gt; 'My Value'.</p></li>
<li><p>capitalize: Capitalize first word of value and convert other words to lower case, e.g. 'MY VALUE' =&gt; 'My
value'.</p></li>
<li><p>braces: Enclose value in curly braces, e.g. 'value =&gt; '{value}'.</p></li>
<li><p>parens: Enclose value in parentheses, e.g. 'value' =&gt; '(value')</p></li>
<li><p>brackets: Enclose value in brackets, e.g. 'value' =&gt; '[value]'</p></li>
<li><p>shell_quote: Quotes the value for safe usage in the shell, e.g. My file.jpeg =&gt; 'My file.jpeg'; only adds
quotes if needed.</p></li>
<li><p>function: Run custom python function to filter value; use in format</p>
<p>'function:/path/to/file.py::function_name'. See example at</p>
<p><a class="reference external" href="https://github.com/RhetTbull/osxphotos/blob/master/examples/template_filter.py">https://github.com/RhetTbull/osxphotos/blob/master/examples/template_filter.py</a></p>
</li>
<li><p>split(x): Split value into a list of values using x as delimiter, e.g. 'value1;value2' =&gt; ['value1',
'value2'] if used with split(;).</p></li>
<li><p>autosplit: Automatically split delimited string into separate values; will split strings delimited by
comma, semicolon, or space, e.g. 'value1,value2' =&gt; ['value1', 'value2'].</p></li>
<li><p>chop(x): Remove x characters off the end of value, e.g. chop(1): 'Value' =&gt; 'Valu'; when applied to a list,
chops characters from each list value, e.g. chop(1): ['travel', 'beach']=&gt; ['trave', 'beac'].</p></li>
<li><p>chomp(x): Remove x characters from the beginning of value, e.g. chomp(1): ['Value'] =&gt; ['alue']; when
applied to a list, removes characters from each list value, e.g. chomp(1): ['travel', 'beach']=&gt; ['ravel',
'each'].</p></li>
<li><p>sort: Sort list of values, e.g. ['c', 'b', 'a'] =&gt; ['a', 'b', 'c'].</p></li>
<li><p>rsort: Sort list of values in reverse order, e.g. ['a', 'b', 'c'] =&gt; ['c', 'b', 'a'].</p></li>
<li><p>reverse: Reverse order of values, e.g. ['a', 'b', 'c'] =&gt; ['c', 'b', 'a'].</p></li>
<li><p>uniq: Remove duplicate values, e.g. ['a', 'b', 'c', 'b', 'a'] =&gt; ['a', 'b', 'c'].</p></li>
<li><p>join(x): Join list of values with delimiter x, e.g. join(,): ['a', 'b', 'c'] =&gt; 'a,b,c'; the DELIM option
functions similar to join(x) but with DELIM, the join happens before being passed to any filters.May
optionally be used without an argument, that is 'join()' which joins values together with no delimiter.
e.g. join(): ['a', 'b', 'c'] =&gt; 'abc'.</p></li>
<li><p>append(x): Append x to list of values, e.g. append(d): ['a', 'b', 'c'] =&gt; ['a', 'b', 'c', 'd'].</p></li>
<li><p>prepend(x): Prepend x to list of values, e.g. prepend(d): ['a', 'b', 'c'] =&gt; ['d', 'a', 'b', 'c'].</p></li>
<li><p>appends(x): Append s[tring] Append x to each value of list of values, e.g. appends(d): ['a', 'b', 'c'] =&gt;
['ad', 'bd', 'cd'].</p></li>
<li><p>prepends(x): Prepend s[tring] x to each value of list of values, e.g. prepends(d): ['a', 'b', 'c'] =&gt;
['da', 'db', 'dc'].</p></li>
<li><p>remove(x): Remove x from list of values, e.g. remove(b): ['a', 'b', 'c'] =&gt; ['a', 'c'].</p></li>
<li><p>slice(start:stop:step): Slice list using same semantics as Python's list slicing, e.g. slice(1:3): ['a',
'b', 'c', 'd'] =&gt; ['b', 'c']; slice(1:4:2): ['a', 'b', 'c', 'd'] =&gt; ['b', 'd']; slice(1:): ['a', 'b', 'c',
'd'] =&gt; ['b', 'c', 'd']; slice(:-1): ['a', 'b', 'c', 'd'] =&gt; ['a', 'b', 'c']; slice(::-1): ['a', 'b', 'c',
'd'] =&gt; ['d', 'c', 'b', 'a']. See also sslice().</p></li>
<li><p>sslice(start:stop:step): [s(tring) slice] Slice values in a list using same semantics as Python's string
slicing, e.g. sslice(1:3):'abcd =&gt; 'bc'; sslice(1:4:2): 'abcd' =&gt; 'bd', etc. See also slice().</p></li>
<li><p>filter(x): Filter list of values using predicate x; for example, '{folder_album|filter(contains Events)}'
returns only folders/albums containing the word 'Events' in their path.</p></li>
<li><p>int: Convert values in list to integer, e.g. 1.0 =&gt; 1. If value cannot be converted to integer, remove
value from list. ['1.1', 'x'] =&gt; ['1']. See also float.</p></li>
<li><p>float: Convert values in list to floating point number, e.g. 1 =&gt; 1.0. If value cannot be converted to
float, remove value from list. ['1', 'x'] =&gt; ['1.0']. See also int.</p></li>
</ul>
</div></blockquote>
<p>e.g. if Photo keywords are [&quot;FOO&quot;,&quot;bar&quot;]:</p>
<blockquote>
<div><ul class="simple">
<li><p>&quot;{keyword|lower}&quot; renders to &quot;foo&quot;, &quot;bar&quot;</p></li>
<li><p>&quot;{keyword|upper}&quot; renders to: &quot;FOO&quot;, &quot;BAR&quot;</p></li>
<li><p>&quot;{keyword|capitalize}&quot; renders to: &quot;Foo&quot;, &quot;Bar&quot;</p></li>
<li><p>&quot;{keyword|lower|parens}&quot; renders to: &quot;(foo)&quot;, &quot;(bar)&quot;</p></li>
</ul>
</div></blockquote>
<p>e.g. if Photo description is &quot;my description&quot;:</p>
<blockquote>
<div><ul class="simple">
<li><p>&quot;{descr|titlecase}&quot; renders to: &quot;My Description&quot;</p></li>
</ul>
</div></blockquote>
<p>e.g. If Photo is in Album1 in Folder1:</p>
<blockquote>
<div><ul class="simple">
<li><p>&quot;{folder_album}&quot; renders to [&quot;Folder1/Album1&quot;]</p></li>
<li><p>&quot;{folder_album(&gt;)}&quot; renders to [&quot;Folder1&gt;Album1&quot;]</p></li>
<li><p>&quot;{folder_album()}&quot; renders to [&quot;Folder1Album1&quot;]</p></li>
</ul>
</div></blockquote>
<p>[find,replace]: optional text replacement to perform on rendered template value.  For example, to replace &quot;/&quot;
in an album name, you could use the template &quot;{album[/,-]}&quot;.  Multiple replacements can be made by appending
&quot;|&quot; and adding another find|replace pair.  e.g. to replace both &quot;/&quot; and &quot;:&quot; in album name: &quot;{album[/,-<a href="#id33"><span class="problematic" id="id34">|:,-]}&quot;.
find/replace pairs are not limited to single characters.  The &quot;|</span></a>&quot; character cannot be used in a find/replace
pair.</p>
<p>conditional: optional conditional expression that is evaluated as boolean (True/False) for use with the
?bool_value modifier.  Conditional expressions take the form 'not operator value' where not is an optional
modifier that negates the operator.  Note: the space before the conditional expression is required if you use
a conditional expression.  Valid comparison operators are:</p>
<blockquote>
<div><ul class="simple">
<li><p>contains: template field contains value, similar to python's in</p></li>
<li><p>matches: template field contains exactly value, unlike contains: does not match partial matches</p></li>
<li><p>startswith: template field starts with value</p></li>
<li><p>endswith: template field ends with value</p></li>
<li><p>&lt;=: template field is less than or equal to value</p></li>
<li><p>&gt;=: template field is greater than or equal to value</p></li>
<li><p>&lt;: template field is less than value</p></li>
<li><p>&gt;: template field is greater than value</p></li>
<li><p>==: template field equals value</p></li>
<li><p>!=: template field does not equal value</p></li>
</ul>
</div></blockquote>
<p>The value part of the conditional expression is treated as a bare (unquoted) word/phrase.  Multiple values may
be separated by '|' (the pipe symbol).  value is itself a template statement so you can use one or more
template fields in value which will be resolved before the comparison occurs.</p>
<p>For example:</p>
<blockquote>
<div><ul class="simple">
<li><p>{keyword matches Beach} resolves to True if 'Beach' is a keyword. It would not match keyword 'BeachDay'.</p></li>
<li><p>{keyword contains Beach} resolves to True if any keyword contains the word 'Beach' so it would match both
'Beach' and 'BeachDay'.</p></li>
<li><p>{photo.score.overall &gt; 0.7} resolves to True if the photo's overall aesthetic score is greater than 0.7.</p></li>
<li><p>{keyword|lower contains beach} uses the lower case filter to do case-insensitive matching to match any
keyword that contains the word 'beach'.</p></li>
<li><p>{keyword|lower not contains beach} uses the not modifier to negate the comparison so this resolves to True
if there is no keyword that matches 'beach'.</p></li>
</ul>
</div></blockquote>
<p>Examples: to export photos that contain certain keywords with the osxphotos export command's --directory
option:</p>
<p>--directory &quot;{keyword|lower matches travel|vacation?Travel-Photos,Not-Travel-Photos}&quot;</p>
<p>This exports any photo that has keywords 'travel' or 'vacation' into a directory 'Travel-Photos' and all other
photos into directory 'Not-Travel-Photos'.</p>
<p>This can be used to rename files as well, for example: --filename
&quot;{favorite?Favorite-{original_name},{original_name}}&quot;</p>
<p>This renames any photo that is a favorite as 'Favorite-ImageName.jpg' (where 'ImageName.jpg' is the original
name of the photo) and all other photos with the unmodified original name.</p>
<p>&amp;combine_value: Template fields may be combined with another template statement to return multiple values. The
combine_value is another template statement. For example, the template {created.year&amp;{folder_album,}} would
resolve to [&quot;1999&quot;, &quot;Vacation&quot;] if the photo was created in 1999 and was in the album Vacation. Because the
combine_value is a template statement, multiple templates may be combined together by nesting the combine
operator: {template1&amp;{template2&amp;{template3,},},}. In this example, a null default value is used to prevent the
default value from being combined if any of the nested templates does not resolve to a value</p>
<p>?bool_value: Template fields may be evaluated as boolean (True/False) by appending &quot;?&quot; after the field name
(and following &quot;(field_arg)&quot; or &quot;[find/replace]&quot;.  If a field is True (e.g. photo is HDR and field is &quot;{hdr}&quot;)
or has any value, the value following the &quot;?&quot; will be used to render the template instead of the actual field
value.  If the template field evaluates to False (e.g. in above example, photo is not HDR) or has no value
(e.g. photo has no title and field is &quot;{title}&quot;) then the default value following a &quot;,&quot; will be used.</p>
<p>e.g. if photo is an HDR image,</p>
<blockquote>
<div><ul class="simple">
<li><p>&quot;{hdr?ISHDR,NOTHDR}&quot; renders to &quot;ISHDR&quot;</p></li>
</ul>
</div></blockquote>
<p>and if it is not an HDR image,</p>
<blockquote>
<div><ul class="simple">
<li><p>&quot;{hdr?ISHDR,NOTHDR}&quot; renders to &quot;NOTHDR&quot;</p></li>
</ul>
</div></blockquote>
<p>,default: optional default value to use if the template name has no value.  This modifier is also used for the
value if False for boolean-type fields (see above) as well as to hold a sub-template for values like
{created.strftime}.  If no default value provided, &quot;_&quot; is used.</p>
<p>e.g., if photo has no title set,</p>
<blockquote>
<div><ul class="simple">
<li><p>&quot;{title}&quot; renders to &quot;_&quot;</p></li>
<li><p>&quot;{title,I have no title}&quot; renders to &quot;I have no title&quot;</p></li>
</ul>
</div></blockquote>
<p>Template fields such as created.strftime use the default value to pass the template to use for strftime.</p>
<p>e.g., if photo date is 4 February 2020, 19:07:38,</p>
<blockquote>
<div><ul class="simple">
<li><p>&quot;{created.strftime,%Y-%m-%d-%H%M%S}&quot; renders to &quot;2020-02-04-190738&quot;</p></li>
</ul>
</div></blockquote>
<p>Some template fields such as &quot;{media_type}&quot; use the default value to allow customization of the output. For
example, &quot;{media_type}&quot; resolves to the special media type of the photo such as panorama or selfie.  You may
use the default value to override these in form: &quot;{media_type,video=vidéo;time_lapse=vidéo_accélérée}&quot;. In
this example, if photo was a time_lapse photo, media_type would resolve to vidéo_accélérée instead of
time_lapse.</p>
<p>Either or both bool_value or default (False value) may be empty which would result in empty string &quot;&quot; when
rendered.</p>
<p>If you want to include &quot;{&quot; or &quot;}&quot; in the output, use &quot;{openbrace}&quot; or &quot;{closebrace}&quot; template substitution.</p>
<p>e.g. &quot;{created.year}/{openbrace}{title}{closebrace}&quot; would result in &quot;2020/{Photo Title}&quot;.</p>
<p>Variables</p>
<p>You can define variables for later use in the template string using the format {var:NAME,VALUE} where VALUE is
a template statement.  Variables may then be referenced using the format %NAME. For example: {var:foo,bar}
defines the variable %foo to have value bar. This can be useful if you want to re-use a complex template value
in multiple places within your template string or for allowing the use of characters that would otherwise be
prohibited in a template string. For example, the &quot;pipe&quot; (|) character is not allowed in a find/replace pair
but you can get around this limitation like so: {var:pipe,{pipe}}{title[-,%pipe]} which replaces the -
character with | (the value of %pipe).</p>
<p>Another use case for variables is filtering combined template values. For example, using the &amp;combine_value
mechanism to combine two template values that might result in duplicate values, you could do the following:
{var:myvar,{template1&amp;{template2,},}}{%myvar|uniq} which allows the use of the uniq filter against the
combined template values.</p>
<p>Variables can also be referenced as fields in the template string, for example:
{var:year,{created.year}}{original_name}-{%year}. In some cases, use of variables can make your template
string more readable.  Variables can be used as template fields, as values for filters, as values for
conditional operations, or as default values.  When used as a conditional value or default value, variables
should be treated like any other field and enclosed in braces as conditional and default values are evaluated
as template strings. For example: {var:name,Katie}{person contains {%name}?{%name},Not-{%name}}.</p>
<p>If you need to use a % (percent sign character), you can escape the percent sign by using %%.  You can also
use the {percent} template field where a template field is required. For example:</p>
<p>{title[:,%%]} replaces the : with % and {title contains Foo?{title}{percent},{title}} adds % to the  title if
it contains Foo.</p>
<p>With the --directory and --filename options you may specify a template for the export directory or filename,
respectively. The directory will be appended to the export path specified in the export DEST argument to
export.  For example, if template is '{created.year}/{created.month}', and export destination DEST is
'/Users/maria/Pictures/export', the actual export directory for a photo would be
'/Users/maria/Pictures/export/2020/March' if the photo was created in March 2020.</p>
<p>The templating system may also be used with the --keyword-template option to set keywords on export (with
--exiftool or --sidecar), for example, to set a new keyword in format 'folder/subfolder/album' to preserve the
folder/album structure, you can use --keyword-template &quot;{folder_album}&quot; or in the 'folder&gt;subfolder&gt;album'
format used in Lightroom Classic, --keyword-template &quot;{folder_album(&gt;)}&quot;.</p>
<p>In the template, valid template substitutions will be replaced by the corresponding value from the table
below.  Invalid substitutions will result in a an error and the script will abort.</p>
<blockquote>
<div><p>Template Substitutions</p>
</div></blockquote>
<p>Substitution                    Description</p>
<p>{name}                          Current filename of the photo</p>
<p>{original_name}                 Photo's original filename when imported to Photos</p>
<p>{title}                         Title of the photo</p>
<p>{descr}                         Description of the photo</p>
<p>{media_type}                    Special media type resolved in this precedence: selfie, time_lapse,</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>panorama, slow_mo, screenshot, screen_recording, portrait, live_photo,
burst, photo, video. Defaults to &#39;photo&#39; or &#39;video&#39; if no special type.
Customize one or more media types using format:
&#39;{media_type,video=vidéo;time_lapse=vidéo_accélérée}&#39;
</pre></div>
</div>
<dl class="simple">
<dt>{photo_or_video}                'photo' or 'video' depending on what type the image is. To customize, use</dt><dd><p>default value as in '{photo_or_video,photo=fotos;video=videos}'</p>
</dd>
<dt>{hdr}                           Photo is HDR?; True/False value, use in format</dt><dd><p>'{hdr?VALUE_IF_TRUE,VALUE_IF_FALSE}'</p>
</dd>
<dt>{edited}                        True if photo has been edited (has adjustments), otherwise False; use in</dt><dd><p>format '{edited?VALUE_IF_TRUE,VALUE_IF_FALSE}'</p>
</dd>
<dt>{edited_version}                True if template is being rendered for the edited version of a photo,</dt><dd><p>otherwise False.</p>
</dd>
<dt>{favorite}                      Photo has been marked as favorite?; True/False value, use in format</dt><dd><p>'{favorite?VALUE_IF_TRUE,VALUE_IF_FALSE}'</p>
</dd>
</dl>
<p>{created}                       Photo's creation date in ISO format, e.g. '2020-03-22'
{created.date}                  Photo's creation date in ISO format, e.g. '2020-03-22'
{created.year}                  4-digit year of photo creation time
{created.yy}                    2-digit year of photo creation time
{created.mm}                    2-digit month of the photo creation time (zero padded)
{created.month}                 Month name in user's locale of the photo creation time
{created.mon}                   Month abbreviation in the user's locale of the photo creation time
{created.dd}                    2-digit day of the month (zero padded) of photo creation time
{created.dow}                   Day of week in user's locale of the photo creation time
{created.doy}                   3-digit day of year (e.g Julian day) of photo creation time, starting from 1</p>
<blockquote>
<div><p>(zero padded)</p>
</div></blockquote>
<p>{created.hour}                  2-digit hour of the photo creation time
{created.min}                   2-digit minute of the photo creation time
{created.sec}                   2-digit second of the photo creation time
{created.strftime}              Apply strftime template to file creation date/time. Should be used in form</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>{created.strftime,TEMPLATE} where TEMPLATE is a valid strftime template,
e.g. {created.strftime,%Y-%U} would result in year-week number of year:
&#39;2020-23&#39;. If used with no template will return null value. See
https://strftime.org/ for help on strftime templates.
</pre></div>
</div>
<dl class="simple">
<dt>{modified}                      Photo's modification date in ISO format, e.g. '2020-03-22'; uses creation</dt><dd><p>date if photo is not modified</p>
</dd>
<dt>{modified.date}                 Photo's modification date in ISO format, e.g. '2020-03-22'; uses creation</dt><dd><p>date if photo is not modified</p>
</dd>
<dt>{modified.year}                 4-digit year of photo modification time; uses creation date if photo is not</dt><dd><p>modified</p>
</dd>
<dt>{modified.yy}                   2-digit year of photo modification time; uses creation date if photo is not</dt><dd><p>modified</p>
</dd>
<dt>{modified.mm}                   2-digit month of the photo modification time (zero padded); uses creation</dt><dd><p>date if photo is not modified</p>
</dd>
<dt>{modified.month}                Month name in user's locale of the photo modification time; uses creation</dt><dd><p>date if photo is not modified</p>
</dd>
<dt>{modified.mon}                  Month abbreviation in the user's locale of the photo modification time; uses</dt><dd><p>creation date if photo is not modified</p>
</dd>
<dt>{modified.dd}                   2-digit day of the month (zero padded) of the photo modification time; uses</dt><dd><p>creation date if photo is not modified</p>
</dd>
<dt>{modified.dow}                  Day of week in user's locale of the photo modification time; uses creation</dt><dd><p>date if photo is not modified</p>
</dd>
<dt>{modified.doy}                  3-digit day of year (e.g Julian day) of photo modification time, starting</dt><dd><p>from 1 (zero padded); uses creation date if photo is not modified</p>
</dd>
<dt>{modified.hour}                 2-digit hour of the photo modification time; uses creation date if photo is</dt><dd><p>not modified</p>
</dd>
<dt>{modified.min}                  2-digit minute of the photo modification time; uses creation date if photo</dt><dd><p>is not modified</p>
</dd>
<dt>{modified.sec}                  2-digit second of the photo modification time; uses creation date if photo</dt><dd><p>is not modified</p>
</dd>
</dl>
<p>{modified.strftime}             Apply strftime template to file modification date/time. Should be used in</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>form {modified.strftime,TEMPLATE} where TEMPLATE is a valid strftime
template, e.g. {modified.strftime,%Y-%U} would result in year-week number of
year: &#39;2020-23&#39;. If used with no template will return null value. Uses
creation date if photo is not modified. See https://strftime.org/ for help
on strftime templates.
</pre></div>
</div>
<p>{today}                         Current date in iso format, e.g. '2020-03-22'
{today.date}                    Current date in iso format, e.g. '2020-03-22'</p>
<p>{today.year}                    4-digit year of current date</p>
<p>{today.yy}                      2-digit year of current date</p>
<p>{today.mm}                      2-digit month of the current date (zero padded)
{today.month}                   Month name in user's locale of the current date
{today.mon}                     Month abbreviation in the user's locale of the current date
{today.dd}                      2-digit day of the month (zero padded) of current date
{today.dow}                     Day of week in user's locale of the current date
{today.doy}                     3-digit day of year (e.g Julian day) of current date, starting from 1 (zero</p>
<blockquote>
<div><p>padded)</p>
</div></blockquote>
<p>{today.hour}                    2-digit hour of the current date
{today.min}                     2-digit minute of the current date
{today.sec}                     2-digit second of the current date
{today.strftime}                Apply strftime template to current date/time. Should be used in form</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>{today.strftime,TEMPLATE} where TEMPLATE is a valid strftime template, e.g.
{today.strftime,%Y-%U} would result in year-week number of year: &#39;2020-23&#39;.
If used with no template will return null value. See https://strftime.org/
for help on strftime templates.
</pre></div>
</div>
<p>{place.name}                    Place name from the photo's reverse geolocation data, as displayed in Photos
{place.country_code}            The ISO country code from the photo's reverse geolocation data
{place.name.country}            Country name from the photo's reverse geolocation data
{place.name.state_province}     State or province name from the photo's reverse geolocation data
{place.name.city}               City or locality name from the photo's reverse geolocation data
{place.name.area_of_interest}   Area of interest name (e.g. landmark or public place) from the photo's</p>
<blockquote>
<div><p>reverse geolocation data</p>
</div></blockquote>
<dl class="simple">
<dt>{place.address}                 Postal address from the photo's reverse geolocation data, e.g. '2007 18th St</dt><dd><p>NW, Washington, DC 20009, United States'</p>
</dd>
</dl>
<p>{place.address.street}          Street part of the postal address, e.g. '2007 18th St NW'
{place.address.city}            City part of the postal address, e.g. 'Washington'
{place.address.state_province}  State/province part of the postal address, e.g. 'DC'
{place.address.postal_code}     Postal code part of the postal address, e.g. '20009'
{place.address.country}         Country name of the postal address, e.g. 'United States'
{place.address.country_code}    ISO country code of the postal address, e.g. 'US'
{searchinfo.season}             Season of the year associated with a photo, e.g. 'Summer'; (Photos 5+ only,</p>
<blockquote>
<div><p>applied automatically by Photos' image categorization algorithms).</p>
</div></blockquote>
<dl class="simple">
<dt>{exif.camera_make}              Camera make from original photo's EXIF information as imported by Photos,</dt><dd><p>e.g. 'Apple'</p>
</dd>
<dt>{exif.camera_model}             Camera model from original photo's EXIF information as imported by Photos,</dt><dd><p>e.g. 'iPhone 6s'</p>
</dd>
<dt>{exif.lens_model}               Lens model from original photo's EXIF information as imported by Photos,</dt><dd><p>e.g. 'iPhone 6s back camera 4.15mm f/2.2'</p>
</dd>
</dl>
<p>{moment}                        The moment title of the photo
{uuid}                          Photo's internal universally unique identifier (UUID) for the photo, a</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>36-character string unique to the photo, e.g.
&#39;128FB4C6-0B16-4E7D-9108-FB2E90DA1546&#39;
</pre></div>
</div>
<p>{shortuuid}                     A shorter representation of photo's internal universally unique identifier</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>(UUID) for the photo, a 22-character string unique to the photo, e.g.
&#39;JYsxugP9UjetmCbBCHXcmu&#39;
</pre></div>
</div>
<p>{id}                            A unique number for the photo based on its primary key in the Photos</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>database. A sequential integer, e.g. 1, 2, 3...etc.  Each asset associated
with a photo (e.g. an image and Live Photo preview) will share the same id.
May be formatted using a python string format code. For example, to format
as a 5-digit integer and pad with zeros, use &#39;{id:05d}&#39; which results in
00001, 00002, 00003...etc.
</pre></div>
</div>
<p>{counter}                       A sequential counter, starting at 0, that increments each time it is</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>evaluated.To start counting at a value other than 0, append append
&#39;(starting_value)&#39; to the field name.For example, to start counting at 1
instead of 0: &#39;{counter(1)}&#39;.May be formatted using a python string format
code.For example, to format as a 5-digit integer and pad with zeros, use
&#39;{counter:05d(1)}&#39;which results in 00001, 00002, 00003...etc.You may also
specify a stop value which causes the counter to reset to the starting
valuewhen the stop value is reached and a step size which causes the counter
to increment bythe specified value instead of 1. Use the format
&#39;{counter(start,stop,step)}&#39; where start,stop, and step are integers. For
example, to count from 1 to 10 by 2, use &#39;{counter(1,11,2)}&#39;.Note that the
counter stops counting when the stop value is reached and does not return
thestop value. Start, stop, and step are optional and may be omitted. For
example, to countfrom 0 by 2s, use &#39;{counter(,,2)}&#39;.You may create an
arbitrary number of counters by appending a unique name to the field
namepreceded by a period: &#39;{counter.a}&#39;, &#39;{counter.b}&#39;, etc. Each counter
will have its own stateand will start at 0 and increment by 1 unless
otherwise specified. Note: {counter} is not suitable for use with &#39;export&#39;
and &#39;--update&#39; as the counter associated with a photo may change between
export sessions. See also {id}.
</pre></div>
</div>
<p>{album_seq}                     An integer, starting at 0, indicating the photo's index (sequence) in the</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>containing album. Only valid when used in a &#39;--filename&#39; template and only
when &#39;{album}&#39; or &#39;{folder_album}&#39; is used in the &#39;--directory&#39; template.
For example &#39;--directory &quot;{folder_album}&quot; --filename
&quot;{album_seq}_{original_name}&quot;&#39;. To start counting at a value other than 0,
append append &#39;(starting_value)&#39; to the field name.  For example, to start
counting at 1 instead of 0: &#39;{album_seq(1)}&#39;. May be formatted using a
python string format code. For example, to format as a 5-digit integer and
pad with zeros, use &#39;{album_seq:05d}&#39; which results in 00000, 00001,
00002...etc. To format while also using a starting value:
&#39;{album_seq:05d(1)}&#39; which results in 0001, 00002...etc.This may result in
incorrect sequences if you have duplicate albums with the same name; see
also &#39;{folder_album_seq}&#39;.
</pre></div>
</div>
<p>{folder_album_seq}              An integer, starting at 0, indicating the photo's index (sequence) in the</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>containing album and folder path. Only valid when used in a &#39;--filename&#39;
template and only when &#39;{folder_album}&#39; is used in the &#39;--directory&#39;
template. For example &#39;--directory &quot;{folder_album}&quot; --filename
&quot;{folder_album_seq}_{original_name}&quot;&#39;. To start counting at a value other
than 0, append &#39;(starting_value)&#39; to the field name. For example, to start
counting at 1 instead of 0: &#39;{folder_album_seq(1)}&#39; May be formatted using a
python string format code. For example, to format as a 5-digit integer and
pad with zeros, use &#39;{folder_album_seq:05d}&#39; which results in 00000, 00001,
00002...etc. To format while also using a starting value:
&#39;{folder_album_seq:05d(1)}&#39; which results in 0001, 00002...etc.This may
result in incorrect sequences if you have duplicate albums with the same
name in the same folder; see also &#39;{album_seq}&#39;.
</pre></div>
</div>
<p>{comma}                         A comma: ','</p>
<p>{semicolon}                     A semicolon: ';'</p>
<p>{questionmark}                  A question mark: '?'</p>
<p>{pipe}                          A vertical pipe: '|'</p>
<p>{percent}                       A percent sign: '%'</p>
<p>{ampersand}                     an ampersand symbol: '&amp;'</p>
<p>{openbrace}                     An open brace: '{'</p>
<p>{closebrace}                    A close brace: '}'</p>
<p>{openparens}                    An open parentheses: '('</p>
<p>{closeparens}                   A close parentheses: ')'</p>
<p>{openbracket}                   An open bracket: '['</p>
<p>{closebracket}                  A close bracket: ']'</p>
<p>{newline}                       A newline: 'n'</p>
<p>{lf}                            A line feed: 'n', alias for {newline}</p>
<p>{cr}                            A carriage return: 'r'</p>
<p>{crlf}                          A carriage return + line feed: 'rn'</p>
<p>{tab}                           :A tab: 't'</p>
<p>{osxphotos_version}             The osxphotos version, e.g. '0.74.2'</p>
<p>{osxphotos_cmd_line}            The full command line used to run osxphotos</p>
<p>The following substitutions may result in multiple values. Thus if specified for --directory these could
result in multiple copies of a photo being being exported, one to each directory.  For example: --directory
'{created.year}/{album}' could result in the same photo being exported to each of the following directories if
the photos were created in 2019 and were in albums 'Vacation' and 'Family': 2019/Vacation, 2019/Family</p>
<p>Substitution             Description</p>
<p>{album}                  Album(s) photo is contained in</p>
<dl class="simple">
<dt>{folder_album}           Folder path + album photo is contained in. e.g. 'Folder/Subfolder/Album' or just</dt><dd><p>'Album' if no enclosing folder</p>
</dd>
</dl>
<p>{project}                Project(s) photo is contained in (such as greeting cards, calendars, slideshows)
{album_project}          Album(s) and project(s) photo is contained in; treats projects as regular albums
{folder_album_project}   Folder path + album (includes projects as albums) photo is contained in. e.g.</p>
<blockquote>
<div><p>'Folder/Subfolder/Album' or just 'Album' if no enclosing folder</p>
</div></blockquote>
<p>{keyword}                Keyword(s) assigned to photo</p>
<p>{person}                 Person(s) / face(s) in a photo
{label}                  Image categorization label associated with a photo (Photos 5+ only). Labels are</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>added automatically by Photos using machine learning algorithms to categorize
images. These are not the same as {keyword} which refers to the user-defined
keywords/tags applied in Photos.
</pre></div>
</div>
<p>{label_normalized}       All lower case version of 'label' (Photos 5+ only)
{comment}                Comment(s) on shared Photos; format is 'Person name: comment text' (Photos 5+ only)
{exiftool}               Format: '{exiftool:GROUP:TAGNAME}'; use exiftool (https://exiftool.org) to extract</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>metadata, in form GROUP:TAGNAME, from image.  E.g. &#39;{exiftool:EXIF:Make}&#39; to get
camera make, or {exiftool:IPTC:Keywords} to extract keywords. See
https://exiftool.org/TagNames/ for list of valid tag names.  You must specify group
(e.g. EXIF, IPTC, etc) as used in &#39;exiftool -G&#39;. exiftool must be installed in the
path to use this template.
</pre></div>
</div>
<dl class="simple">
<dt>{searchinfo.holiday}     Holiday names associated with a photo, e.g. 'Christmas Day'; (Photos 5+ only,</dt><dd><p>applied automatically by Photos' image categorization algorithms).</p>
</dd>
<dt>{searchinfo.activity}    Activities associated with a photo, e.g. 'Sporting Event'; (Photos 5+ only, applied</dt><dd><p>automatically by Photos' image categorization algorithms).</p>
</dd>
<dt>{searchinfo.venue}       Venues associated with a photo, e.g. name of restaurant; (Photos 5+ only, applied</dt><dd><p>automatically by Photos' image categorization algorithms).</p>
</dd>
<dt>{searchinfo.venue_type}  Venue types associated with a photo, e.g. 'Restaurant'; (Photos 5+ only, applied</dt><dd><p>automatically by Photos' image categorization algorithms).</p>
</dd>
</dl>
<p>{photo}                  Provides direct access to the PhotoInfo object for the photo. Must be used in</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>format &#39;{photo.property}&#39; where &#39;property&#39; represents a PhotoInfo property. For
example: &#39;{photo.favorite}&#39; is the same as &#39;{favorite}&#39; and &#39;{photo.place.name}&#39; is
the same as &#39;{place.name}&#39;. &#39;{photo}&#39; provides access to properties that are not
available as separate template fields but it assumes some knowledge of the
underlying PhotoInfo class.  See https://rhettbull.github.io/osxphotos/ for
additional documentation on the PhotoInfo class.
</pre></div>
</div>
<p>{detected_text}          List of text strings found in the image after performing text detection. Using</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>&#39;{detected_text}&#39; will cause osxphotos to perform text detection on your photos
using the built-in macOS text detection algorithms which will slow down your
export. The results for each photo will be cached in the export database so that
future exports with &#39;--update&#39; do not need to reprocess each photo. You may pass a
confidence threshold value between 0.0 and 1.0 after a colon as in
&#39;{detected_text:0.5}&#39;; The default confidence threshold is 0.75. &#39;{detected_text}&#39;
works only on macOS Catalina (10.15) or later. Note: this feature is not the same
thing as Live Text in macOS Monterey, which osxphotos does not yet support.
</pre></div>
</div>
<p>{shell_quote}            Use in form '{shell_quote,TEMPLATE}'; quotes the rendered TEMPLATE value(s) for</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>safe usage in the shell, e.g. My file.jpeg =&gt; &#39;My file.jpeg&#39;; only adds quotes if
needed.
</pre></div>
</div>
<dl class="simple">
<dt>{strip}                  Use in form '{strip,TEMPLATE}'; strips whitespace from begining and end of rendered</dt><dd><p>TEMPLATE value(s).</p>
</dd>
</dl>
<p>{format}                 Use in form '{format:TYPE:FORMAT,TEMPLATE}'; converts TEMPLATE value to TYPE then</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>formats the value using Python string formatting codes specified by FORMAT; TYPE is
one of: &#39;int&#39;, &#39;float&#39;, or &#39;str&#39;. For example,
&#39;{format:float:.1f,{exiftool:EXIF:FocalLength}}&#39; will format focal length to 1
decimal place (e.g. &#39;100.0&#39;).
</pre></div>
</div>
<p>{function}               Execute a python function from an external file and use return value as template</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>substitution. Use in format: {function:file.py::function_name} where &#39;file.py&#39; is
the path/name of the python file and &#39;function_name&#39; is the name of the function to
call. The file name may also be url to a python file, e.g. &#39;{function:https://raw.g
ithubusercontent.com/RhetTbull/osxphotos/main/examples/template_function.py::exampl
e}&#39;. The function will be passed the PhotoInfo object for the photo. See
https://github.com/RhetTbull/osxphotos/blob/master/examples/template_function.py
for an example of how to implement a template function.
</pre></div>
</div>
<p>The following substitutions are file or directory paths. You can access various parts of the path using the
following modifiers:</p>
<p>{path.parent}: the parent directory
{path.name}: the name of the file or final sub-directory
{path.stem}: the name of the file without the extension
{path.suffix}: the suffix of the file including the leading '.'</p>
<p>For example, if the field {export_dir} is '/Shared/Backup/Photos':
{export_dir.parent} is '/Shared/Backup'</p>
<p>If the field {filepath} is '/Shared/Backup/Photos/IMG_1234.JPG':
{filepath.parent} is '/Shared/Backup/Photos'</p>
<p>{filepath.name} is 'IMG_1234.JPG'</p>
<p>{filepath.stem} is 'IMG_1234'</p>
<p>{filepath.suffix} is '.JPG'</p>
<p>Substitution  Description
{export_dir}  The full path to the export directory
{filepath}    The full path to the exported file</p>
<blockquote>
<div><p>Post Command</p>
</div></blockquote>
<p>You can run commands on the exported photos for post-processing using the '--post-command' option. '--post-
command' is passed a CATEGORY and a COMMAND. COMMAND is an osxphotos template string which will be rendered
and passed to the shell for execution. CATEGORY is the category of file to pass to COMMAND. The following
categories are available:</p>
<p>Category                  Description</p>
<p>exported                  All exported files</p>
<p>new                       When used with '--update', all newly exported files
updated                   When used with '--update', all files which were previously exported but updated</p>
<blockquote>
<div><p>this time</p>
</div></blockquote>
<dl class="simple">
<dt>skipped                   When used with '--update', all files which were skipped (because they were</dt><dd><p>previously exported and didn't change)</p>
</dd>
<dt>missing                   All files which were not exported because they were missing from the Photos</dt><dd><p>library</p>
</dd>
</dl>
<p>exif_updated              When used with '--exiftool', all files on which exiftool updated the metadata
touched                   When used with '--touch-file', all files where the date was touched
converted_to_jpeg         When used with '--convert-to-jpeg', all files which were converted to jpeg
sidecar_json_written      When used with '--sidecar json', all JSON sidecar files which were written
sidecar_json_skipped      When used with '--sidecar json' and '--update', all JSON sidecar files which were</p>
<blockquote>
<div><p>skipped</p>
</div></blockquote>
<p>sidecar_exiftool_written  When used with '--sidecar exiftool', all exiftool sidecar files which were written
sidecar_exiftool_skipped  When used with '--sidecar exiftool' and '--update, all exiftool sidecar files</p>
<blockquote>
<div><p>which were skipped</p>
</div></blockquote>
<p>sidecar_xmp_written       When used with '--sidecar xmp', all XMP sidecar files which were written
sidecar_xmp_skipped       When used with '--sidecar xmp' and '--update', all XMP sidecar files which were</p>
<blockquote>
<div><p>skipped</p>
</div></blockquote>
<p>error                     All files which produced an error during export</p>
<p>In addition to all normal template fields, the template fields '{filepath}' and '{export_dir}' will be
available to your command template. Both of these are path-type templates which means their various parts can
be accessed using the available properties, e.g. '{filepath.name}' provides just the file name without path
and '{filepath.suffix}' is the file extension (suffix) of the file. When using paths in your command template,
it is important to properly quote the paths as they will be passed to the shell and path names may contain
spaces. Both the '{shell_quote}' template and the '<a href="#id5"><span class="problematic" id="id6">|</span></a>shell_quote' template filter are available for this
purpose.  For example, the following command outputs the full path of newly exported files to file 'new.txt':</p>
<p>--post-command new &quot;echo {filepath|shell_quote} &gt;&gt; {shell_quote,{export_dir}/exported.txt}&quot;</p>
<p>In the above command, the 'shell_quote' filter is used to ensure '{filepath}' is properly quoted and the
'{shell_quote}' template ensures the constructed path of '{exported_dir}/exported.txt' is properly quoted. If
'{filepath}' is 'IMG 1234.jpeg' and '{export_dir}' is '/Volumes/Photo Export', the command thus renders to:</p>
<p>echo 'IMG 1234.jpeg' &gt;&gt; '/Volumes/Photo Export/exported.txt'</p>
<p>It is highly recommended that you run osxphotos with '--dry-run --verbose' first to ensure your commands are
as expected. This will not actually run the commands but will print out the exact command string which would
be executed.</p>
<blockquote>
<div><p>Post Function</p>
</div></blockquote>
<p>You can run your own python functions on the exported photos for post-processing using the '--post-function'
option. '--post-function' is passed the name a python file and the name of the function in the file to call
using format 'filename.py::function_name'. See the example function at
https://github.com/RhetTbull/osxphotos/blob/master/examples/post_function.py You may specify multiple
functions to run by repeating the --post-function option. All post functions will be called immediately after
export of each photo and immediately before any --post-command commands. Post functions will not be called if
the --dry-run flag is set.</p>
</section>
<section id="osxphotos-exportdb">
<h3>exportdb<a class="headerlink" href="#osxphotos-exportdb" title="Link to this heading">¶</a></h3>
<p>Utilities for working with the osxphotos export database</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>exportdb<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>EXPORT_DATABASE
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-version">
<span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-version" title="Link to this definition">¶</a></dt>
<dd><p>Print export database version and exit.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-vacuum">
<span class="sig-name descname"><span class="pre">--vacuum</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-vacuum" title="Link to this definition">¶</a></dt>
<dd><p>Run VACUUM to defragment the database.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-create">
<span class="sig-name descname"><span class="pre">--create</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;VERSION&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-create" title="Link to this definition">¶</a></dt>
<dd><p>Create a new export database with VERSION.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-check-signatures">
<span class="sig-name descname"><span class="pre">--check-signatures</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-check-signatures" title="Link to this definition">¶</a></dt>
<dd><p>Check signatures for all exported photos in the database to find signatures that don't match.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-update-signatures">
<span class="sig-name descname"><span class="pre">--update-signatures</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-update-signatures" title="Link to this definition">¶</a></dt>
<dd><p>Update signatures for all exported photos in the database to match on-disk signatures.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-touch-file">
<span class="sig-name descname"><span class="pre">--touch-file</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-touch-file" title="Link to this definition">¶</a></dt>
<dd><p>Touch files on disk to match created date in Photos library and update export database signatures</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-runs">
<span class="sig-name descname"><span class="pre">--runs</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-runs" title="Link to this definition">¶</a></dt>
<dd><p>List osxphotos commands used with this database. See also --last-run.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-last-run">
<span class="sig-name descname"><span class="pre">--last-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-last-run" title="Link to this definition">¶</a></dt>
<dd><p>Show last run osxphotos commands used with this database. See also --runs.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-last-export-dir">
<span class="sig-name descname"><span class="pre">--last-export-dir</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-last-export-dir" title="Link to this definition">¶</a></dt>
<dd><p>Print path to last used export directory</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-save-config">
<span class="sig-name descname"><span class="pre">--save-config</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CONFIG_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-save-config" title="Link to this definition">¶</a></dt>
<dd><p>Save last run configuration to TOML file for use by --load-config.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-info">
<span class="sig-name descname"><span class="pre">--info</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-info" title="Link to this definition">¶</a></dt>
<dd><p>Print information about FILE_PATH contained in the database.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-errors">
<span class="sig-name descname"><span class="pre">--errors</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-errors" title="Link to this definition">¶</a></dt>
<dd><p>Print list of files that had warnings/errors on export (from all runs).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-last-errors">
<span class="sig-name descname"><span class="pre">--last-errors</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-last-errors" title="Link to this definition">¶</a></dt>
<dd><p>Print list of files that had warnings/errors on last export run.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-uuid-files">
<span class="sig-name descname"><span class="pre">--uuid-files</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-uuid-files" title="Link to this definition">¶</a></dt>
<dd><p>List exported files associated with UUID.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-uuid-info">
<span class="sig-name descname"><span class="pre">--uuid-info</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-uuid-info" title="Link to this definition">¶</a></dt>
<dd><p>Print information about UUID contained in the database.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-history">
<span class="sig-name descname"><span class="pre">--history</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE_PATH_OR_UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-history" title="Link to this definition">¶</a></dt>
<dd><p>Print history of FILE_PATH_OR_UUID contained in the database.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-delete-uuid">
<span class="sig-name descname"><span class="pre">--delete-uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-delete-uuid" title="Link to this definition">¶</a></dt>
<dd><p>Delete all data associated with UUID from the database.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-delete-file">
<span class="sig-name descname"><span class="pre">--delete-file</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-delete-file" title="Link to this definition">¶</a></dt>
<dd><p>Delete all data associated with FILE_PATH from the database; does not delete the actual exported file if it exists, only the data in the database.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-report">
<span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REPORT_FILE</span> <span class="pre">RUN_ID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-report" title="Link to this definition">¶</a></dt>
<dd><p>Generate an export report as 'osxphotos export ... --report REPORT_FILE' would have done. This allows you to re-create an export report if you didn't use the --report option when running 'osxphotos export'. The extension of the report file is used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). RUN_ID may be any integer from -10 to 0 specifying which run to use. For example, '--report report.csv 0' will generate a CSV report for the last run and '--report report.json -1' will generate a JSON report for the second-to-last run (one run prior to last run). REPORT_FILE may be a template string (see Templating System), for example, --report 'export_{today.date}.csv' will write a CSV report file named with today's date. See also --append.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-upgrade">
<span class="sig-name descname"><span class="pre">--upgrade</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-upgrade" title="Link to this definition">¶</a></dt>
<dd><p>Upgrade (if needed) export database to current version.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-check">
<span class="sig-name descname"><span class="pre">--check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-check" title="Link to this definition">¶</a></dt>
<dd><p>Check export database for errors.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-repair">
<span class="sig-name descname"><span class="pre">--repair</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-repair" title="Link to this definition">¶</a></dt>
<dd><p>Repair export database. This may be useful if the export database is corrupted and osxphotos reports 'database disk image is malformed' errors.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-sql">
<span class="sig-name descname"><span class="pre">--sql</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SQL_STATEMENT&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-sql" title="Link to this definition">¶</a></dt>
<dd><p>Execute SQL_STATEMENT against export database and print results.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-migrate-photos-library">
<span class="sig-name descname"><span class="pre">--migrate-photos-library</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-migrate-photos-library" title="Link to this definition">¶</a></dt>
<dd><p>Migrate the export database to use the specified Photos library. Use this if you have moved your Photos library to a new location or computer and want to keep using the same export database. This will update the UUIDs in the export database to match the new Photos library.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-export-dir">
<span class="sig-name descname"><span class="pre">--export-dir</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;export_dir&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-export-dir" title="Link to this definition">¶</a></dt>
<dd><p>Optional path to export directory (if not parent of export database).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-append">
<span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-append" title="Link to this definition">¶</a></dt>
<dd><p>If used with --report, add data to existing report file instead of overwriting it. See also --report.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-V">
<span id="cmdoption-osxphotos-exportdb-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-timestamp">
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-timestamp" title="Link to this definition">¶</a></dt>
<dd><p>Add time stamp to verbose output</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-theme">
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-theme" title="Link to this definition">¶</a></dt>
<dd><p>Specify the color theme to use for output. Valid themes are 'dark', 'light', 'mono', and 'plain'. Defaults to 'dark' or 'light' depending on system dark mode setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>dark | light | mono | plain</p>
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-dry-run">
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-dry-run" title="Link to this definition">¶</a></dt>
<dd><p>Run in dry-run mode (don't actually update files); for example, use with --update-signatures or --migrate-photos-library.</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-arg-EXPORT_DATABASE">
<span class="sig-name descname"><span class="pre">EXPORT_DATABASE</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-arg-EXPORT_DATABASE" title="Link to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>

</section>
<section id="osxphotos-help">
<h3>help<a class="headerlink" href="#osxphotos-help" title="Link to this heading">¶</a></h3>
<p>Print help; for help on commands: help &lt;command&gt;.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span><span class="nb">help</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span><span class="o">[</span>TOPIC<span class="o">]</span><span class="w"> </span><span class="o">[</span>SUBTOPIC<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-help-arg-TOPIC">
<span class="sig-name descname"><span class="pre">TOPIC</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-help-arg-TOPIC" title="Link to this definition">¶</a></dt>
<dd><p>Optional argument</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-help-arg-SUBTOPIC">
<span class="sig-name descname"><span class="pre">SUBTOPIC</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-help-arg-SUBTOPIC" title="Link to this definition">¶</a></dt>
<dd><p>Optional argument</p>
</dd></dl>

</section>
<section id="osxphotos-import">
<h3>import<a class="headerlink" href="#osxphotos-import" title="Link to this heading">¶</a></h3>
<p>Import photos and videos into Photos. Photos will be imported into the
most recently opened Photos library.</p>
<p>Limitations:</p>
<ul class="simple">
<li><p>Photos are imported one at a time</p></li>
</ul>
<p>Thus the &quot;Imports&quot; album in Photos will show a new import group for each photo imported.</p>
<p>Exception: On macOS &gt;= 11.0, Live photos (photo+video pair), burst photos, edited photos,
and RAW+JPEG pairs will be imported together so that Photos processes them correctly.
Automatic grouping of live photos and burst photos is not supported on macOS &lt;= 10.15.</p>
<p>Edited Photos:</p>
<p>The import command will attempt to preserve adjustments to photos so that the imported asset
preserves the non-destructive edits. For this to work, there must be an associated .AAE file
for the photo. The .AAE file stores non-destructive edits to the photo and can be exported with
'osxphotos export ... --export-aae'. If the original file is named IMG_1234.jpg, the .AAE file
should be named IMG_1234.aae or IMG_1234.AAE.</p>
<p>The edited version of the file must also be named following one of these two conventions:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Original: IMG_1234.jpg, edited: IMG_E1234.jpg

Original: IMG_1234.jpg, original: IMG_1234_edited.jpg
</pre></div>
</div>
<p>In the first form, the original is named with 3 letters, followed by underscore, followed by
4 digits and the edited has the same name with &quot;E&quot; in front of the 4 digits.</p>
<p>In the second form, a suffix is appended to the original name, in this example, &quot;_edited&quot;, which
is the default suffix used by 'osxphotos export'. If you have used a different suffix, you can specify
it using '--edited-suffix SUFFIX'.</p>
<p>If edited files do not contain an associated .AAE or if they do not match one of these two conventions,
they will be imported as separate assets.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>import<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span><span class="o">[</span>FILES_OR_DIRS<span class="o">]</span>...
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-a">
<span id="cmdoption-osxphotos-import-album"></span><span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM_TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-a" title="Link to this definition">¶</a></dt>
<dd><p>Import photos into album ALBUM_TEMPLATE. ALBUM_TEMPLATE is an osxphotos template string. Photos may be imported into more than one album by repeating --album. See also --skip-dups, --dup-albums, --split-folder, --relative-to. See Template System in help for additional information.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-t">
<span id="cmdoption-osxphotos-import-title"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TITLE_TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-t" title="Link to this definition">¶</a></dt>
<dd><p>Set title of imported photos to TITLE_TEMPLATE. TITLE_TEMPLATE is a an osxphotos template string. See Template System in help for additional information.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-d">
<span id="cmdoption-osxphotos-import-description"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DESCRIPTION_TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-d" title="Link to this definition">¶</a></dt>
<dd><p>Set description of imported photos to DESCRIPTION_TEMPLATE. DESCRIPTION_TEMPLATE is a an osxphotos template string. See Template System in help for additional information.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-k">
<span id="cmdoption-osxphotos-import-keyword"></span><span class="sig-name descname"><span class="pre">-k</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;KEYWORD_TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-k" title="Link to this definition">¶</a></dt>
<dd><p>Set keywords of imported photos to KEYWORD_TEMPLATE. KEYWORD_TEMPLATE is a an osxphotos template string. More than one keyword may be set by repeating --keyword. See Template System in help for additional information.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-m">
<span id="cmdoption-osxphotos-import-merge-keywords"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--merge-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-m" title="Link to this definition">¶</a></dt>
<dd><p>Merge keywords created by --exiftool, --sidecar, --sidecar-filename, or --keyword with any keywords already associated with the photo. Without --merge-keywords, existing keywords will be overwritten.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-l">
<span id="cmdoption-osxphotos-import-location"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;LATITUDE</span> <span class="pre">LONGITUDE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-l" title="Link to this definition">¶</a></dt>
<dd><p>Set location of imported photo to LATITUDE LONGITUDE. Latitude is a number in the range -90.0 to 90.0; positive latitudes are north of the equator, negative latitudes are south of the equator. Longitude is a number in the range -180.0 to 180.0; positive longitudes are east of the Prime Meridian; negative longitudes are west of the Prime Meridian.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-G">
<span id="cmdoption-osxphotos-import-favorite-rating"></span><span class="sig-name descname"><span class="pre">-G</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--favorite-rating</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;RATING&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-G" title="Link to this definition">¶</a></dt>
<dd><p>If XMP:Rating is set to RATING or higher, mark imported photo as a favorite. RATING must be in range 1 to 5. XMP:Rating will be read from asset's metadata or from sidecar if --sidecar, --sidecare-filename is used. Requires that exiftool be installed to read the rating from the asset's XMP data.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-E">
<span id="cmdoption-osxphotos-import-auto-live"></span><span class="sig-name descname"><span class="pre">-E</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--auto-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-E" title="Link to this definition">¶</a></dt>
<dd><p>Automatically convert photo+video pairs into live images. Live Photos (photo+video pair) exported from Photos contain a metadata content identifier that Photos uses to associate the pair as a single Live Photo asset when re-imported. Photo+video pairs taken on non-Apple devices will lack the content identifier and thus will be imported as separate assets. Use --auto-live to automatically convert these pairs to Live Photos upon import. When --auto-live is used, a photo and a video with same base name, for example 'IMG_1234.JPG' and 'IMG_1234.mov', in the same directory will be converted to Live Photos. <em>NOTE</em>: Using this feature will modify the metadata in the files prior to import. Ensure you have a backup of the original files if you want to preserve unmodified versions. <em>NOTE</em>: this option does not work on macOS &lt; 11.0.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-P">
<span id="cmdoption-osxphotos-import-parse-date"></span><span class="sig-name descname"><span class="pre">-P</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--parse-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE_PATTERN&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-P" title="Link to this definition">¶</a></dt>
<dd><p>Parse date from filename using DATE_PATTERN. If file does not match DATE_PATTERN, the date will be set by Photos using Photo's default behavior. DATE_PATTERN is a strptime-compatible pattern with extensions as pattern described below. For example, if your photos are named 'IMG_1234_2022_11_23_12_34_56.jpg' where the date/time is '2022-11-23 12:34:56', you could use the pattern '%Y_%m_%d_%H_%M_%S' or 'IMG_*_%Y_%m_%d_%H_%M_%S' to further narrow the pattern to only match files with '<a href="#id35"><span class="problematic" id="id36">IMG_xxxx_</span></a>' in the name. If the pattern matches only date or only time, the missing information will be set to the default date/time used by Photos when importing the photo. This is either the EXIF date/time if it exists or the file modification date/time. For example, if photos are named 'IMG_1234_2022_11_23.jpg' where the date is '2022-11-23', you could use the pattern '%Y_%m_%d' to set the date but the time would be set from the EXIF or the file's modification time. If the DATE_PATTERN matches time zone information, you must also use --set-timezone to allow osxphotos to set the timezone in the Photos database. See also --parse-folder-date, --check-templates, --set-timezone.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-F">
<span id="cmdoption-osxphotos-import-parse-folder-date"></span><span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--parse-folder-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE_PATTERN&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-F" title="Link to this definition">¶</a></dt>
<dd><p>Parse date from folder name using DATE_PATTERN. If folder does not match DATE_PATTERN, the date will be set by Photos using Photo's default behavior. DATE_PATTERN is a strptime-compatible pattern with extensions as pattern described below. If DATE_PATTERN matches time zone information, the time will be set to the local time in the timezone as the import command does not yet support setting time zone information. For example, if your photos are in folder '2023/12/17/IMG_1234.jpg' where the date is '2023-12-17', you could use the pattern '%Y/%m/%d$' as the DATE_PATTERN. If the pattern matches only date or only time, the missing information will be set to the default date/time used by Photos when importing the photo. This is either the EXIF date/time if it exists or the file modification date/time. See also --parse-folder-date, --check-templates.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-X">
<span id="cmdoption-osxphotos-import-clear-metadata"></span><span class="sig-name descname"><span class="pre">-X</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--clear-metadata</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-X" title="Link to this definition">¶</a></dt>
<dd><p>Clear any metadata set automatically by Photos upon import. Normally, Photos will set title, description, and keywords from XMP metadata in the imported file.  If you specify --clear-metadata, any metadata set by Photos will be cleared after import.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-L">
<span id="cmdoption-osxphotos-import-clear-location"></span><span class="sig-name descname"><span class="pre">-L</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--clear-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-L" title="Link to this definition">¶</a></dt>
<dd><p>Clear any location data automatically imported by Photos. Normally, Photos will set location of the photo to the location data found in the metadata in the imported file.  If you specify --clear-location, this data will be cleared after import.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-z">
<span id="cmdoption-osxphotos-import-timezone"></span><span class="sig-name descname"><span class="pre">-z</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timezone</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIMEZONE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-z" title="Link to this definition">¶</a></dt>
<dd><p>Set timezone for imported photos as offset from UTC or to named IANA timezone. Format is one of '±HH:MM', '±H:MM', '±HHMM', or named timezone such as 'America/Los_Angeles' or 'PST'. For list of valid IANA timezone names, see <a class="reference external" href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a>. This option useful if your imported photos contain the correct date/time but not the timezone or an incorrect timezone. If there is no timezone data, Photos will apply the current local timezone to the photo. If you took the photos in a different timezone with a camera that did not apply timezone, the --timezone option is useful to set the correct timezone. When using --timezone, osxphotos will assume the date/time is correct for the target timezone and will adjust the date/time as needed. For example, if you took a photo at 9:00 AM in New York and you are currently in Los Angeles, you would use --timezone 'America/New_York' to set the timezone to New_York. The time of the photos will be adjusted to 6:00 AM in Los Angeles so that the photo is displayed at the correct time (9:00 AM in New York) in the Photos app.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-e">
<span id="cmdoption-osxphotos-import-exiftool"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--exiftool</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-e" title="Link to this definition">¶</a></dt>
<dd><p>Use third party tool exiftool (<a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>) to automatically update metadata (title, description, keywords, location) in imported photos from the imported file's metadata. See also --sidecar, --sidecar-filename, --exportdb. Note: importing keywords from video files is not currently supported.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-p">
<span id="cmdoption-osxphotos-import-exiftool-path"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--exiftool-path</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXIFTOOL_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-p" title="Link to this definition">¶</a></dt>
<dd><p>Optionally specify path to exiftool; if not provided, will look for exiftool in $PATH.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-s">
<span id="cmdoption-osxphotos-import-sidecar"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--sidecar</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-s" title="Link to this definition">¶</a></dt>
<dd><p>Use sidecar files to import metadata (title, description, keywords, location). Sidecar files must be in the same directory as the imported file and have the same name. For example, if image is named img_1234.jpg, sidecar must be named one of: img_1234.xmp, img_1234.json, img_1234.jpg.xmp, img_1234.jpg.json. Supported sidecar formats are XMP and JSON (as generated by exiftool). If both JSON and XMP sidecars are found, the JSON sidecar will be used. If sidecar format is XMP, exiftool must be installed as it is used to read the XMP files. See also --sidecar-filename if you need control over the sidecar name. See also --sidecar-ignore-date, --exiftool, --exportdb. Note: --sidecar and --sidecar-filename are mutually exclusive.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-T">
<span id="cmdoption-osxphotos-import-sidecar-filename"></span><span class="sig-name descname"><span class="pre">-T</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--sidecar-filename</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-T" title="Link to this definition">¶</a></dt>
<dd><p>Use sidecar files to import metadata (title, description, keywords, location). The TEMPLATE is an osxphotos template string that is rendered to produce the sidecar filename. The path to the current file is available as {filepath}. Thus if file is named 'IMG_1234.jpg' and sidecar is named 'IMG_1234.xmp', you would use the template '{filepath.parent}/{filepath.stem}.xmp'. If the sidecar name was 'IMG_1234.jpg.xmp', you would use the template '{filepath}.xmp'. If the sidecar format is XMP, exiftool must be installed as it is used to read the XMP files. See Template System in help for additional information. See also --sidecar-ignore-date, --exiftool, --exportdb. Note: --sidecar and --sidecar-filename are mutually exclusive.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-edited-suffix">
<span class="sig-name descname"><span class="pre">--edited-suffix</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-edited-suffix" title="Link to this definition">¶</a></dt>
<dd><p>Optional suffix template used for naming edited photos. This is used to associate sidecars to the edited version of a file when --sidecar or --sidecar-filename is used and also to associate edited images to the original when importing adjustments exported with 'osxphotos export --export-aae'. By default, osxphotos will look for edited photos using default 'osxphotos export' suffix of '_edited' If your edited photos have a different suffix you can use '--edited-suffix' to specify the suffix. For example, with '--edited-suffix _bearbeiten', the import command will look for a file named 'photoname_bearbeiten.ext' and associated that with a sidecar named 'photoname.xmp', etc. Multi-value templates (see Templating System in the OSXPhotos docs) are not permitted with --edited-suffix.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-i">
<span id="cmdoption-osxphotos-import-sidecar-ignore-date"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--sidecar-ignore-date</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-i" title="Link to this definition">¶</a></dt>
<dd><p>Do not use date/time in sidecar to set photo date/time. There may be situations where you want to apply the metadata from the sidecar but ignore the date/time in the sidecar. One of these is when using --exportdb to restore from the export database. The export database stores the named timezone of the photo and will set it but the sidecar metadata standards do not support storing the named timezone. Thus if using both --exportdb and --sidecar, you may want to use --sidecar-ignore-date otherwise the date/time in the sidecar will overwrite the date/time (and timezone name) from the export database. Additionally, Google Takeout does not preserve timezone information in the sidecar and converts all times to UTC. If you are importing photos from Google Takeout and the photos contain the correct date/time and timezone offset, you may want to use --sidecar-ignore-date to ignore the date/time in the sidecar and use the date/time from the photo metadata.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-Z">
<span id="cmdoption-osxphotos-import-set-timezone"></span><span class="sig-name descname"><span class="pre">-Z</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--set-timezone</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-Z" title="Link to this definition">¶</a></dt>
<dd><p>Set the named timezone of the imported photos in the Photos database when used with --exportdb or --parse-date. Photos does not provide a way to set the timezone of a photo directly. Upon import, osxphotos can read the timezone from the export database if using --exportdb or from the filename if using --parse-date. The --set-timezone option will set the named timezone of the photo by directly writing the timezone name to the Photos database. This has been well tested but because it uses an undocumented Photos API, it may be possible to corrupt the Photos database. If you want to set the timezone of the imported photos, use --set-timezone.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-B">
<span id="cmdoption-osxphotos-import-exportdb"></span><span class="sig-name descname"><span class="pre">-B</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--exportdb</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXPORTDB_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-B" title="Link to this definition">¶</a></dt>
<dd><p>Use an osxphotos export database (created by 'osxphotos export') to set metadata (title, description, keywords, location, album, date/time, timezone). See also --exportdir, --sidecar, --sidecar-filename, --exiftool. If using with --sidecar, it is recommended you also use --sidecar-ignore-date.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-I">
<span id="cmdoption-osxphotos-import-exportdir"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--exportdir</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXPORT_DIR_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-I" title="Link to this definition">¶</a></dt>
<dd><p>Specify the path to the export directory when using --exportdb to import metadata from an osxphotos export database created by 'osxphotos export'. This is only needed if you have moved the exported files to a new location since the export. If you have moved the exported files, osxphotos will need to know the path to the top-level of the export directory in order to use --exportdb to read the metadata for the files. For example, if you used 'osxphotos export' to export photos to '/Volumes/Exported' but you subsequently moved the files to '/Volumes/PhotosBackup' you would use: '--exportdb /Volumes/PhotosBackup --exportdir /Volumes/PhotosBackup' to import the metadata from the export database. This is needed because osxphotos needs to know both the path to the export database and the root folder of the exported files in order to match the files to the correct entry in the export database and the database may be in a different location than the exported files. See also --exportdb.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-r">
<span id="cmdoption-osxphotos-import-relative-to"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--relative-to</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;RELATIVE_TO_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-r" title="Link to this definition">¶</a></dt>
<dd><p>If set, the '{filepath}' template will be computed relative to RELATIVE_TO_PATH. For example, if path to import is '/Volumes/photos/import/album/img_1234.jpg' then '{filepath}' will be this same value. If you set '--relative-to /Volumes/photos/import' then '{filepath}' will be set to 'album/img_1234.jpg'</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-D">
<span id="cmdoption-osxphotos-import-dup-check"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--dup-check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-D" title="Link to this definition">¶</a></dt>
<dd><p>Use Photos' built-in duplicate checkign to check for duplicates on import. Using --dup-check will cause Photos to display a dialog box for each duplicate photo found, requesting confirmation to import the duplicate. See also --skip-dups.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-S">
<span id="cmdoption-osxphotos-import-skip-dups"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--skip-dups</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-S" title="Link to this definition">¶</a></dt>
<dd><p>Skip duplicate photos on import; osxphotos will not import any photos that appear to be duplicates. Unlike --dup-check, this does not use Photos' built in duplicate checking feature and does not display a dialog box for each duplicate found. See also --dup-check, --dup-albums, and --resume.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-U">
<span id="cmdoption-osxphotos-import-signature"></span><span class="sig-name descname"><span class="pre">-U</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--signature</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;signature&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-U" title="Link to this definition">¶</a></dt>
<dd><p>Custom template for signature when using --skip-dups, --dup-check, and --dup-albums. The signature is used to match photos in the library to those being imported. If you do not use --signature, the fingerprint will be used for photos and lowercase filename + size will be used for videos (a fingerprint is not always stored for videos in the Photos library). <em>Note</em>: When using --signature, the Photos library will be scanned before import which may take some time. If there are duplicates files in the list of files to be imported, these will not be detected as each imported file will only be compared to the state of the Photos library at the start of the import.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-A">
<span id="cmdoption-osxphotos-import-dup-albums"></span><span class="sig-name descname"><span class="pre">-A</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--dup-albums</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-A" title="Link to this definition">¶</a></dt>
<dd><p>If used with --skip-dups, the matching duplicate already in the Photos library will be added to any albums the current file would have been added to had it not been skipped. This is useful if you have duplicate photos in separate folders and want to avoid duplicates in Photos but keep the photos organized in albums that match the folder structure. Must be used with --skip-dups and --album or --exportdb. See also --skip-dups.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-f">
<span id="cmdoption-osxphotos-import-split-folder"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--split-folder</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;split_folder&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-f" title="Link to this definition">¶</a></dt>
<dd><p>Automatically create hierarchal folders for albums as needed by splitting album name into folders and album. You must specify the character used to split folders and albums. For example, '--split-folder &quot;/&quot;' will split the album name 'Folder/Album' into folder 'Folder' and album 'Album'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-w">
<span id="cmdoption-osxphotos-import-walk"></span><span class="sig-name descname"><span class="pre">-w</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--walk</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-w" title="Link to this definition">¶</a></dt>
<dd><p>Recursively walk through directories.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-g">
<span id="cmdoption-osxphotos-import-glob"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--glob</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;GLOB&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-g" title="Link to this definition">¶</a></dt>
<dd><p>Only import files matching GLOB. GLOB is a Unix shell-style glob pattern, for example: '--glob *.jpg'. GLOB may be repeated to import multiple patterns.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-c">
<span id="cmdoption-osxphotos-import-check"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-c" title="Link to this definition">¶</a></dt>
<dd><p>Check which FILES have been previously imported but do not actually import anything. Prints a report showing which files have been imported (and when they were added) and which files have not been imported. See also, --check-not.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-C">
<span id="cmdoption-osxphotos-import-check-not"></span><span class="sig-name descname"><span class="pre">-C</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--check-not</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-C" title="Link to this definition">¶</a></dt>
<dd><p>Check which FILES have not been previously imported but do not actually import anything. Prints the path to each file that has not been previously imported. See also, --check.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-n">
<span id="cmdoption-osxphotos-import-dry-run"></span><span class="sig-name descname"><span class="pre">-n</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-n" title="Link to this definition">¶</a></dt>
<dd><p>Dry run; do not actually import. Useful with --verbose to see what would be imported.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-o">
<span id="cmdoption-osxphotos-import-report"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REPORT_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-o" title="Link to this definition">¶</a></dt>
<dd><p>Write a report of all files that were imported. The extension of the report filename will be used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). REPORT_FILE may be a template string (see Template System), for example, --report 'export_{today.date}.csv' will write a CSV report file named with today's date. See also --append.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-R">
<span id="cmdoption-osxphotos-import-resume"></span><span class="sig-name descname"><span class="pre">-R</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--resume</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-R" title="Link to this definition">¶</a></dt>
<dd><p>Resume previous import, skipping any files which have already been imported. Note: data on each imported file is kept in a database in '/Users/rhet/.local/share/osxphotos/osxphotos_import.db'. This data can be used to resume a previous import if there was an error or the import was cancelled. Any files which were already imported will be skipped. See also --skip-dups.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-O">
<span id="cmdoption-osxphotos-import-append"></span><span class="sig-name descname"><span class="pre">-O</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-O" title="Link to this definition">¶</a></dt>
<dd><p>If used with --report, add data to existing report file instead of overwriting it. See also --report.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-V">
<span id="cmdoption-osxphotos-import-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-timestamp">
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-timestamp" title="Link to this definition">¶</a></dt>
<dd><p>Add time stamp to verbose output</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-N">
<span id="cmdoption-osxphotos-import-no-progress"></span><span class="sig-name descname"><span class="pre">-N</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no-progress</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-N" title="Link to this definition">¶</a></dt>
<dd><p>Do not display progress bar during import.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-check-templates">
<span class="sig-name descname"><span class="pre">--check-templates</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-check-templates" title="Link to this definition">¶</a></dt>
<dd><p>Don't actually import anything; renders template strings and date patterns so you can verify they are correct.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-post-function">
<span class="sig-name descname"><span class="pre">--post-function</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;filename.py::function&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-post-function" title="Link to this definition">¶</a></dt>
<dd><p>Run python function after importing file.Use this in format: --post-function filename.py::function where filename.py is a python file you've created and function is the name of the function in the python file you want to call. The function will be passed a reference to the photo object and the path to the file that was imported. You can run more than one function by repeating the '--post-function' option with different arguments. You may also specify a post function using a URL in format --post-function 'https://path/to/module.py::function' See Post Function below.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-stop-on-error">
<span class="sig-name descname"><span class="pre">--stop-on-error</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;COUNT&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-stop-on-error" title="Link to this definition">¶</a></dt>
<dd><p>Stops importing after COUNT errors. Useful if you experience a large number of errors during import.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-force">
<span class="sig-name descname"><span class="pre">--force</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-force" title="Link to this definition">¶</a></dt>
<dd><p>Bypass confirmation prompt when using --timezone or --set-timezone .  Use with caution.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-library">
<span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-library" title="Link to this definition">¶</a></dt>
<dd><p>Path to the Photos library you are importing into. This is not usually needed. You will only need to specify this if osxphotos cannot determine the path to the library in which case osxphotos will tell you to use the --library option when you run the import command.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-theme">
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-import-theme" title="Link to this definition">¶</a></dt>
<dd><p>Specify the color theme to use for output. Valid themes are 'dark', 'light', 'mono', and 'plain'. Defaults to 'dark' or 'light' depending on system dark mode setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>dark | light | mono | plain</p>
</dd>
</dl>
</dd></dl>

<p>Examples</p>
<p>Import a file into Photos:</p>
<p>osxphotos import /Volumes/photos/img_1234.jpg</p>
<p>Import multiple jpg files into Photos:</p>
<p>osxphotos import /Volumes/photos/<a href="#id7"><span class="problematic" id="id8">*</span></a>.jpg</p>
<p>Import files into Photos and add to album:</p>
<p>osxphotos import /Volumes/photos/<a href="#id9"><span class="problematic" id="id10">*</span></a>.jpg --album &quot;My Album&quot;</p>
<p>Import files into Photos and add to album named for 4-digit year of file creation date:</p>
<p>osxphotos import /Volumes/photos/<a href="#id11"><span class="problematic" id="id12">*</span></a>.jpg --album &quot;{created.year}&quot;</p>
<p>Import files into Photos and add to album named for month of the year in folder named
for the 4-digit year of the file creation date:</p>
<p>osxphotos import /Volumes/photos/<a href="#id13"><span class="problematic" id="id14">*</span></a>.jpg --album &quot;{created.year}/{created.month}&quot; --split-folder &quot;/&quot;</p>
<p>Albums</p>
<p>The imported files may be added to one or more albums using the '--album' option.
The value passed to '--album' may be a literal string or an osxphotos template
(see Template System below).  For example:</p>
<p>osxphotos import /Volumes/photos/<a href="#id15"><span class="problematic" id="id16">*</span></a>.jpg --album &quot;Vacation&quot;</p>
<p>adds all photos to the album &quot;Vacation&quot;.  The album will be created if it does not
already exist.</p>
<p>osxphotos import /Volumes/photos/Madrid/<a href="#id17"><span class="problematic" id="id18">*</span></a>.jpg --album &quot;{filepath.parent.name}&quot;</p>
<p>adds all photos to the album &quot;Madrid&quot; (the name of the file's parent folder).</p>
<p>Folders</p>
<p>If you want to organize the imported photos into both folders and albums, you can
use the '--split-folder' option.  For example, if your photos are organized into
folders as follows:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>/
├── 2021
│   ├── Family
│   └── Travel
└── 2022
├── Family
└── Travel
</pre></div>
</div>
<p>You can recreate this hierarchal structure on import using</p>
<p>'--album &quot;{filepath.parent}&quot; --split-folder &quot;/&quot;</p>
<p>In this example, '{filepath.parent}' renders to '2021/Family', '2021/Travel', etc.
and '--split-folder &quot;/&quot; instructs osxphotos to split the album name into separate
parts '2021' and 'Family'.</p>
<p>If your photos are organized in a set of folders but you want to exclude one or more parent
folders from the list of folders and album, you can use the '--relative-to' option to specify
the parent path that all subsequent paths should be relative to.  For example, if your photos
are organized into photos as follows:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>/
└── Volumes
└── Photos
├── 2021
│   ├── Family
│   └── Travel
└── 2022
├── Family
└── Travel
</pre></div>
</div>
<p>and you want to exclude /Volumes/Photos from the folder/album path, you can do this:</p>
<p>osxphotos import /Volumes/Photos/* --walk --album &quot;{filepath.parent}&quot; --relative-to &quot;/Volumes/Photos&quot; --split-folder &quot;/&quot;</p>
<p>This will produce folders/albums '2021/Family', '2021/Travel', and so on.</p>
<p>Note: in Photos, only albums can contain photos and folders
may contain albums or other folders.</p>
<p>Duplicate Checking</p>
<p>By default, osxphotos import' will import all files passed to it even if duplicates
exist in the Photos library. If you want to skip duplicate files, you can use the
'--skip-dups' option which will cause osxphotos to check for exact duplicates (based on file fingerprint)
and skip those files. Alternatively, you can use '--dup-check' to enable Photos' own duplicate
checking. If a duplicate is encountered with '--dup-check', Photos will prompt you
to skip or import the duplicate file.</p>
<p>If you use the '--verbose' option, osxphotos will report on any duplicates it finds
even if you don't use '--skip-dups' or '--dup-check'.  This is useful with --dry-run
to see if any duplicates exist in the Photos library before importing.</p>
<p>Metadata</p>
<p>'osxphotos import' can set metadata (title, description, keywords, and location) for
imported photos/videos using several options.</p>
<p>If you have exiftool (<a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>) installed, osxphotos can use
exiftool to extract metadata from the imported file and use this to update
the metadata in Photos.</p>
<p>The '--exiftool' option will automatically attempt to update title,
description, keywords, and location from the file's metadata:</p>
<p>osxphotos import <a href="#id19"><span class="problematic" id="id20">*</span></a>.jpg --exiftool</p>
<p>The following metadata fields are read (in priority order) and used to set
the metadata of the imported photo:</p>
<ul class="simple">
<li><p>Title: XMP:Title, IPTC:ObjectName, QuickTime:DisplayName</p></li>
<li><p>Description: XMP:Description, IPTC:Caption-Abstract, EXIF:ImageDescription, QuickTime:Description</p></li>
<li><p>Keywords: XMP:Subject, XMP:TagsList, IPTC:Keywords (QuickTime:Keywords not supported)</p></li>
<li><p>Location: EXIF:GPSLatitude/EXIF:GPSLatitudeRef, EXIF:GPSLongitude/EXIF:GPSLongitudeRef, QuickTime:GPSCoordinates, UserData:GPSCoordinates</p></li>
</ul>
<p>When importing photos, Photos itself will usually read most of these same fields
and set the metadata but when importing via AppleScript (which is how 'osxphotos
import' interacts with Photos), Photos does not always reliably do this. It is
recommended you use '--exiftool' to ensure metadata gets correctly imported.</p>
<p>You can also use '--clear-metadata' to remove any metadata automatically set by
Photos upon import.</p>
<p>In addition to '--exiftool', you can specify a template (see Template System below)
for setting title ('--title'), description ('--description'), and keywords ('--keywords').
Location can be set using '--location'.  The album(s) of the imported file can likewise
be specified with '--album'.</p>
<p>'--title', '--description', '--keyword', and '--album' all take a literal string or an
osxphotos template string.  If a template string is used, the template is rendered
using the osxphotos template language to produce the final value.</p>
<p>For example:</p>
<p>'--title &quot;{exiftool:XMP:Title}&quot;' sets the title of the imported file to whatever value
is in the 'XMP:Title' metadata field (as read by 'exiftool').</p>
<p>'--keyword &quot;Vacation&quot;' sets the keyword for the imported file to the literal string &quot;Vacation&quot;.</p>
<p>If the photo metadata or sidecar contains the names of persons in the image (e.g. 'XMP:PersonInImage'),
you can use the '{person}' template to add the names of the persons to the keywords.  For example:</p>
<p>'--keyword &quot;{person}&quot;' will add the names of the persons in the image to the keywords.</p>
<p>This is helpful as Photos will not import person names from the metadata and osxphotos
cannot set person names in Photos (this is a limitation of Photos).</p>
<p>To use the '{person}' template, you must have exiftool installed and in your path or
the data must be in a sidecar file.</p>
<p>Template System</p>
<p>As mentioned above, the '--title', '--description', '--keyword', and '--album' options
all take an osxphotos template language template string that is further rendered to
produce the final value.  The template system used by osxphotos import' is a subset
of the template system used by 'osxphotos export'. For a complete description of the
template system, see 'osxphotos help export'.</p>
<p>Most fields in the osxphotos template system are not available to osxphotos import' as
they are derived from data in the Photos library and the photos will obviously not be
imported yet. The following fields are available:</p>
<p>{exiftool}</p>
<ul class="simple">
<li><p>'{exiftool}': Format: '{exiftool:GROUP:TAGNAME}'; use exiftool (https://exiftool.org)</p></li>
</ul>
<p>to extract metadata, in form GROUP:TAGNAME, from image.
E.g. '{exiftool:EXIF:Make}' to get camera make, or {exiftool:IPTC:Keywords} to extract
keywords. See https://exiftooip=l.org/TagNames/ for list of valid tag names.
You must specify group (e.g. EXIF, IPTC, etc) as used in 'exiftool -G'.
exiftool must be installed in the path to use this template (alternatively, you can use
'--exiftool-path' to specify the path to exiftool.)</p>
<p>{filepath}</p>
<ul class="simple">
<li><p>'{filepath}': The full path to the file being imported.</p></li>
</ul>
<p>For example, '/Volumes/photos/img_1234.jpg'.</p>
<p>'{filepath}' has several subfields that</p>
<p>allow you to access various parts of the path using the following subfield modifiers:</p>
<ul class="simple">
<li><p>'{filepath.parent}': the parent directory</p></li>
<li><p>'{filepath.name}': the name of the file or final sub-directory</p></li>
<li><p>'{filepath.stem}': the name of the file without the extension</p></li>
<li><p>'{filepath.suffix}': the suffix of the file including the leading '.'</p></li>
</ul>
<p>For example, if the field '{filepath}' is '/Shared/Backup/Photos/IMG1234.JPG':
- '{filepath.parent}' is '/Shared/Backup/Photos'
- '{filepath.name}' is 'IMG1234.JPG'
- '{filepath.stem}' is 'IMG_1234'
- '{filepath.suffix}' is '.JPG'</p>
<p>Subfields may be chained, for example, '{filepath.parent.parent}' in the above
example would be '/Shared/Backup' and '{filepath.parent.name}' would be 'Photos'.</p>
<p>'{filepath}' may be modified using the '--relative-to' option.  For example,
if the path to the imported photo is '/Volumes/Photos/Folder1/Album1/IMG1234.jpg'
and you specify '--relative-to &quot;/Volumes/Photos&quot; then '{filepath}' will be set</p>
<p>to 'Folder1/Album1/IMG1234.jpg'</p>
<p>(a subset of the path relative to the value of '--relative-to').</p>
<p>{created}</p>
<ul class="simple">
<li><p>'{created}': The date the file was created.  '{created}' must be used with a subfield to</p></li>
</ul>
<p>specify the format of the date.
'{created}': The date the file was created.  '{created}' must be used with a subfield to
specify the format of the date.</p>
<ul class="simple">
<li><p>'{created.date}': Photo's creation date in ISO format, e.g. '2020-03-22'</p></li>
</ul>
<p>'{created.date}': Photo's creation date in ISO format, e.g. '2020-03-22'</p>
<ul class="simple">
<li><p>'{created.year}': 4-digit year of photo creation time</p></li>
<li><p>'{created.yy}': 2-digit year of photo creation time</p></li>
<li><p>'{created.mm}': 2-digit month of the photo creation time (zero padded)</p></li>
<li><p>'{created.month}': Month name in user's locale of the photo creation time</p></li>
<li><p>'{created.mon}': Month abbreviation in the user's locale of the photo creation time</p></li>
<li><p>'{created.dd}': 2-digit day of the month (zero padded) of photo creation time</p></li>
<li><p>'{created.dow}': Day of week in user's locale of the photo creation time</p></li>
<li><p>'{created.doy}': 3-digit day of year (e.g Julian day) of photo creation time, starting from 1 (zero padded)</p></li>
<li><p>'{created.hour}': 2-digit hour of the photo creation time</p></li>
<li><p>'{created.min}': 2-digit minute of the photo creation time</p></li>
<li><p>'{created.sec}': 2-digit second of the photo creation time</p></li>
<li><p>'{created.strftime}': Apply strftime template to file creation date/time. Should be used in form</p></li>
</ul>
<p>'{created.strftime,TEMPLATE}' where TEMPLATE is a valid strftime template, e.g.
'{created.strftime,%Y-%U}' would result in year-week number of year: '2020-23'.
If used with no template will return null value.
See <a class="reference external" href="https://strftime.org/">https://strftime.org/</a> for help on strftime templates.
You may find the '--check-templates' option useful for testing templates.
When run with '--check-templates' osxphotos will not actually import anything
but will instead print out the rendered value for each '--title', '--description',
'--keyword', and '--album' option. It will also print out the values extracted by
the '--exiftool' option.</p>
<p>Parsing Dates/Times from File and Folder Names</p>
<p>The '--parse-date' option allows you to parse dates/times from the filename of the
file being imported.  This is useful if you have a large number of files with
dates/times embedded in the filename but not in the metadata.</p>
<p>Likewise, you can use '--parse-folder-date' to parse dates/times from the name of the
folder containing the file being imported.</p>
<p>The argument to '--parse-date' is a pattern string that is used to parse the date/time
from the filename. The pattern string is a superset of the python 'strftime/strptime'
format with the following additions:</p>
<ul class="simple">
<li><p><a href="#id21"><span class="problematic" id="id22">*</span></a>: Match any number of characters</p></li>
<li><p>^: Match the beginning of the string</p></li>
<li><p>$: Match the end of the string</p></li>
<li><p>{n}: Match exactly n characters</p></li>
<li><p>{n,}: Match at least n characters</p></li>
<li><p>{n,m}: Match at least n characters and at most m characters</p></li>
<li><p>In addition to '%%' for a literal '%', the following format codes are supported:</p></li>
</ul>
<p>'%^', '%$', '%', '%|', '%{', '%}' for '^', '$', '', '|', '{', '}' respectively
- <a href="#id23"><span class="problematic" id="id24">|</span></a>: join multiple format codes; each code is tried in order until one matches
- Unlike the standard library, the leading zero is not optional for
%d, %m, %H, %I, %M, %S, %j, %U, %W, and %V
- For optional leading zero, use %-d, %-m, %-H, %-I, %-M, %-S, %-j, %-U, %-W, and %-V
For more information on strptime format codes, see:
<a class="reference external" href="https://docs.python.org/3/library/datetime.html?highlight=strptime#strftime-and-strptime-format-codes">https://docs.python.org/3/library/datetime.html?highlight=strptime#strftime-and-strptime-format-codes</a></p>
<p>Examples</p>
<p>If you have photos with embedded names in filenames like 'IMG123420200322123456.jpg'
and '1234567820200322.jpg', you can parse the dates with the following pattern:
'--parse-date &quot;IMG*%Y%m%d%H%M%S|*%Y%m%d.*&quot;'. The first pattern matches the first format
and the second pattern matches the second. The '|' character is used to separate the two
patterns. The order is important as the first pattern will be tried first then the second
and so on. If you have multiple formats in your filenames you will want to order the patterns
from most specific to least specific to avoid false matches.</p>
<p>If your photos are organized by date into folders in format 'YYYY/MM/DD', for example,
'/Volumes/Photos/2020/03/22/IMG_1234.jpg', you can parse the date from the folder name
using '--parse-folder-date &quot;%Y/%m/%d$&quot;'. In this example, the pattern is anchored to the
end of the string using '$' to avoid false matches if other parts of the path happen to match
the pattern.</p>
<p>Post Function</p>
<p>You can run a custom python function after each photo is imported using '--post-function'.
The format is 'osxphotos import /file/to/import --post-function postfunction.py::postfunction'
where 'postfunction.py' is the name of the python file containing the function and 'postfunction'
is the name of the function. The function will be called with the following arguments:
'post_function(photo: photoscript.Photo, filepath: pathlib.Path, verbose: t.Callable, <a href="#id25"><span class="problematic" id="id26">*</span></a>*kwargs)'</p>
<ul class="simple">
<li><p>photo: photoscript.Photo instance for the photo that's just been imported</p></li>
<li><p>filepath: pathlib.Path to the file that was imported (this is the path to the source file, not the path inside the Photos library)</p></li>
<li><p>verbose: A function to print verbose output if --verbose is set; if --verbose is not set, acts as a no-op (nothing gets printed)</p></li>
<li><p>*kwargs: reserved for future use; recommend you include *kwargs so your function still works if additional arguments are added in future versions</p></li>
</ul>
<p>The function will get called immediately after the photo has been imported into Photos
and all metadata been set (e.g. --exiftool, --title, etc.)</p>
<p>You may call more than one function by repeating the '--post-function' option.</p>
<p>See <a class="reference external" href="https://rhettbull.github.io/PhotoScript/">https://rhettbull.github.io/PhotoScript/</a>
for documentation on photoscript and the Photo class that is passed to the function.</p>
<p>Google Takeout</p>
<p>If you have a Google Takeout archive of your Google Photos library, you can import
it using the following steps:</p>
<ul class="simple">
<li><p>Download the Google Takout archive from Google Photos</p></li>
<li><p>Unzip the archive</p></li>
<li><p>Run the following command to import the photos into Photos:</p></li>
</ul>
<p>osxphotos import /path/to/Takeout --walk --album &quot;{filepath.parent.name}&quot; --sidecar  --verbose --report takeout_import.csv</p>
<p>If you have persons tagged in Google Photos you can add this option to create keywords
for each person in the photo: '--keyword &quot;{person}&quot;'</p>
<p>Google Takeout does not preserve the timezone of the photo. The metadata JSON sidecar
produced by Google converts photo times to UTC. The import command will convert these
to the correct time in the local timezone upon import. If your photos contain the correct
date/time and timezone information in the metadata you can use the '--sidecar-ignore-date'
option to ignore the date/time in the sidecar and use the date/time from the photo metadata.</p>
</section>
<section id="osxphotos-info">
<h3>info<a class="headerlink" href="#osxphotos-info" title="Link to this heading">¶</a></h3>
<p>Print out descriptive info of the Photos library database.</p>
<p>Use --verbose to see additional details such as detailed counts of keywords, etc.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>info<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-info-V">
<span id="cmdoption-osxphotos-info-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-info-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-info-library">
<span id="cmdoption-osxphotos-info-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-info-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-info-json">
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-info-json" title="Link to this definition">¶</a></dt>
<dd><p>Print output in JSON format.</p>
</dd></dl>

</section>
<section id="osxphotos-inspect">
<h3>inspect<a class="headerlink" href="#osxphotos-inspect" title="Link to this heading">¶</a></h3>
<p>Interactively inspect photos selected in Photos.</p>
<p>Open Photos then run 'osxphotos inspect' in the terminal.
As you select a photo in Photos, inspect will display metadata about the photo.
Press Ctrl+C to exit when done.
Works best with a modern terminal like iTerm2 or Kitty.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>inspect<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-inspect-t">
<span id="cmdoption-osxphotos-inspect-detect-text"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--detect-text</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-inspect-t" title="Link to this definition">¶</a></dt>
<dd><p>Detect text in photos</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-inspect-T">
<span id="cmdoption-osxphotos-inspect-template"></span><span class="sig-name descname"><span class="pre">-T</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--template</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-inspect-T" title="Link to this definition">¶</a></dt>
<dd><p>Template string to render for each photo using template preview mode. Useful for testing templates for export; may be repeated to test multiple templates. If --template/-T is used, other inspection data will not be displayed.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-inspect-theme">
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-inspect-theme" title="Link to this definition">¶</a></dt>
<dd><p>Specify the color theme to use for output. Valid themes are 'dark', 'light', 'mono', and 'plain'. Defaults to 'dark' or 'light' depending on system dark mode setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>dark | light | mono | plain</p>
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-inspect-library">
<span id="cmdoption-osxphotos-inspect-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-inspect-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-inspect-beta">
<span class="sig-name descname"><span class="pre">--beta</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-inspect-beta" title="Link to this definition">¶</a></dt>
<dd><p>Include beta properties in output</p>
</dd></dl>

</section>
<section id="osxphotos-install">
<h3>install<a class="headerlink" href="#osxphotos-install" title="Link to this heading">¶</a></h3>
<p>Install Python packages into the same environment as osxphotos</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>install<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span><span class="o">[</span>PACKAGES<span class="o">]</span>...
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-install-U">
<span id="cmdoption-osxphotos-install-upgrade"></span><span class="sig-name descname"><span class="pre">-U</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--upgrade</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-install-U" title="Link to this definition">¶</a></dt>
<dd><p>Upgrade packages to latest version.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-install-r">
<span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-install-r" title="Link to this definition">¶</a></dt>
<dd><p>Install from requirements file FILE.</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-install-arg-PACKAGES">
<span class="sig-name descname"><span class="pre">PACKAGES</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-install-arg-PACKAGES" title="Link to this definition">¶</a></dt>
<dd><p>Optional argument(s)</p>
</dd></dl>

</section>
<section id="osxphotos-keywords">
<h3>keywords<a class="headerlink" href="#osxphotos-keywords" title="Link to this heading">¶</a></h3>
<p>Print out keywords found in the Photos library.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>keywords<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-keywords-library">
<span id="cmdoption-osxphotos-keywords-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-keywords-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-keywords-json">
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-keywords-json" title="Link to this definition">¶</a></dt>
<dd><p>Print output in JSON format.</p>
</dd></dl>

</section>
<section id="osxphotos-labels">
<h3>labels<a class="headerlink" href="#osxphotos-labels" title="Link to this heading">¶</a></h3>
<p>Print out image classification labels found in the Photos library.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>labels<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-labels-library">
<span id="cmdoption-osxphotos-labels-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-labels-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-labels-json">
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-labels-json" title="Link to this definition">¶</a></dt>
<dd><p>Print output in JSON format.</p>
</dd></dl>

</section>
<section id="osxphotos-list">
<h3>list<a class="headerlink" href="#osxphotos-list" title="Link to this heading">¶</a></h3>
<p>Print list of Photos libraries found on the system.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>list<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-list-json">
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-list-json" title="Link to this definition">¶</a></dt>
<dd><p>Print output in JSON format.</p>
</dd></dl>

</section>
<section id="osxphotos-orphans">
<h3>orphans<a class="headerlink" href="#osxphotos-orphans" title="Link to this heading">¶</a></h3>
<p>Find orphaned photos in a Photos library</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>orphans<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-orphans-export">
<span class="sig-name descname"><span class="pre">--export</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXPORT_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-orphans-export" title="Link to this definition">¶</a></dt>
<dd><p>Export orphans to directory EXPORT_PATH. If --export not specified, orphans are listed but not exported.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-orphans-library">
<span id="cmdoption-osxphotos-orphans-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-orphans-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-orphans-V">
<span id="cmdoption-osxphotos-orphans-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-orphans-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-orphans-timestamp">
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-orphans-timestamp" title="Link to this definition">¶</a></dt>
<dd><p>Add time stamp to verbose output</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-orphans-theme">
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-orphans-theme" title="Link to this definition">¶</a></dt>
<dd><p>Specify the color theme to use for output. Valid themes are 'dark', 'light', 'mono', and 'plain'. Defaults to 'dark' or 'light' depending on system dark mode setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>dark | light | mono | plain</p>
</dd>
</dl>
</dd></dl>

</section>
<section id="osxphotos-persons">
<h3>persons<a class="headerlink" href="#osxphotos-persons" title="Link to this heading">¶</a></h3>
<p>Print out persons (faces) found in the Photos library.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>persons<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-persons-library">
<span id="cmdoption-osxphotos-persons-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-persons-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-persons-json">
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-persons-json" title="Link to this definition">¶</a></dt>
<dd><p>Print output in JSON format.</p>
</dd></dl>

</section>
<section id="osxphotos-places">
<h3>places<a class="headerlink" href="#osxphotos-places" title="Link to this heading">¶</a></h3>
<p>Print out places found in the Photos library.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>places<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-places-library">
<span id="cmdoption-osxphotos-places-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-places-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-places-json">
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-places-json" title="Link to this definition">¶</a></dt>
<dd><p>Print output in JSON format.</p>
</dd></dl>

</section>
<section id="osxphotos-push-exif">
<h3>push-exif<a class="headerlink" href="#osxphotos-push-exif" title="Link to this heading">¶</a></h3>
<p>Write photo metadata to original files in the Photos library</p>
<p>METADATA must be one or more of the following, separated by commas:
all keywords location faces persons datetime title description</p>
<ul class="simple">
<li><p>all: all metadata</p></li>
<li><p>keywords: keywords/tags (e.g. IPTC:Keywords, etc.)</p></li>
<li><p>location: location information (e.g. EXIF:GPSLatitude, EXIF:GPSLongitude, etc.)</p></li>
<li><p>faces: face region information (e.g. XMP:RegionName, etc.)</p></li>
<li><p>persons: person in image information (e.g. XMP:PersonInImage, etc.)</p></li>
<li><p>datetime: date/time information (e.g. EXIF:DateTimeOriginal, etc.)</p></li>
<li><p>title: title information (e.g. XMP:Title, etc.)</p></li>
<li><p>description: description information (e.g. XMP:Description, etc.)</p></li>
</ul>
<p>For example to push (write) keywords and faces information to the original files:
'osxphotos push-exif keywords,faces'</p>
<p>To write all metadata to the original files:
'osxphotos push-exif all'</p>
<p>This command will use exiftool (which must be installed separately)
to write metadata to the original files in the Photos library.</p>
<p>The metadata in Photos database including keywords, persons/faces, titles, etc.
will be written to the original files.  This is useful if you want to ensure that
the original file retains the metadata in the Photos database.</p>
<p>You may use options to control which metadata is written to the original files.
Metadata may also optionally be written to edited photos/videos using '--push-edited'.</p>
<p>WARNING: This command will modify the original files in the Photos library.
It is recommended that you make a backup of your Photos library before running
this command. It is also not recommended that you run this command on a library
that is managed by iCloud Photos. Changes to files in an iCloud library may not
be synced back to iCloud. This is most useful for libraries that are not managed
by iCloud Photos or for libraries using referenced files.</p>
<p>The metadata is stored in a SQLite database in your home directory and will be used
to automatically update or skip files as needed on subsequent runs of this command.</p>
<p>Several options such as '--keyword-template' allow you to specify a template string
to use to generate keywords.  See OSXPhotos Template System in 'osxphotos docs' for more details
as well as 'osxphotos template' for an interactive template editor.</p>
<p>If you want to compare metadata between Photos and the original files without
writing metadata, use the '--compare' option.  This will print a report of any
differences between the metadata in Photos and the original files but will not
modify any files. You may also use the '--dry-run' option to see what would be
done without actually writing any files. This is useful for testing the command
before actually writing metadata to files.</p>
<p>push-exif cannot be used on photos in classic shared albums. These photos will
be automatically skipped.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>push-exif<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>METADATA
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-push-edited">
<span class="sig-name descname"><span class="pre">--push-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-push-edited" title="Link to this definition">¶</a></dt>
<dd><p>Push EXIF data to edited photos in addition to originals.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-exiftool-path">
<span class="sig-name descname"><span class="pre">--exiftool-path</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXIFTOOL_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-exiftool-path" title="Link to this definition">¶</a></dt>
<dd><p>Optionally specify path to exiftool; if not provided, will look for exiftool in $PATH.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-exiftool-option">
<span class="sig-name descname"><span class="pre">--exiftool-option</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;OPTION&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-exiftool-option" title="Link to this definition">¶</a></dt>
<dd><p>Optional flag/option to pass to exiftool. For example, --exiftool-option '-m' to ignore minor warnings. Specify these as you would on the exiftool command line. See exiftool docs at <a class="reference external" href="https://exiftool.org/exiftool_pod.html">https://exiftool.org/exiftool_pod.html</a> for full list of options. More than one option may be specified by repeating the option, e.g. --exiftool-option '-m' --exiftool-option '-F'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-exiftool-merge-keywords">
<span class="sig-name descname"><span class="pre">--exiftool-merge-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-exiftool-merge-keywords" title="Link to this definition">¶</a></dt>
<dd><p>Merge any keywords found in the original file with keywords from Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-exiftool-merge-persons">
<span class="sig-name descname"><span class="pre">--exiftool-merge-persons</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-exiftool-merge-persons" title="Link to this definition">¶</a></dt>
<dd><p>Merge any persons found in the original file with persons from Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-favorite-rating">
<span class="sig-name descname"><span class="pre">--favorite-rating</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-favorite-rating" title="Link to this definition">¶</a></dt>
<dd><p>Set XMP:Rating=5 for photos marked as Favorite and XMP:Rating=0 for non-Favorites. If not specified, XMP:Rating is not set.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-ignore-date-modified">
<span class="sig-name descname"><span class="pre">--ignore-date-modified</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-ignore-date-modified" title="Link to this definition">¶</a></dt>
<dd><p>Will ignore the photo modification date and set EXIF:ModifyDate to EXIF:DateTimeOriginal; this is consistent with how Photos handles the EXIF:ModifyDate tag.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-person-keyword">
<span class="sig-name descname"><span class="pre">--person-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-person-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Use person in image as keyword/tag when writing metadata.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-album-keyword">
<span class="sig-name descname"><span class="pre">--album-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-album-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Use album name as keyword/tag when writing metadata.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-keyword-template">
<span class="sig-name descname"><span class="pre">--keyword-template</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-keyword-template" title="Link to this definition">¶</a></dt>
<dd><p>Specify a template string to use as keyword. For example, if you wanted to add the full path to the folder and album photo is contained in as a keyword when writing metadata, you could specify --keyword-template &quot;{folder_album}&quot; You may specify more than one template, for example --keyword-template &quot;{folder_album}&quot; --keyword-template &quot;{created.year}&quot;. See '--replace-keywords' and OSXPhotos Template System in 'osxphotos docs'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-replace-keywords">
<span class="sig-name descname"><span class="pre">--replace-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-replace-keywords" title="Link to this definition">¶</a></dt>
<dd><p>Replace keywords with any values specified with --keyword-template. By default, --keyword-template will add keywords to any keywords already associated with the photo.  If --replace-keywords is specified, values from --keyword-template will replace any existing keywords instead of adding additional keywords.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-description-template">
<span class="sig-name descname"><span class="pre">--description-template</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-description-template" title="Link to this definition">¶</a></dt>
<dd><p>Specify a template string to use as description. For example, if you wanted to append 'updated with osxphotos on [today's date]' to the description, you could specify --description-template &quot;{descr} updated with osxphotos on {today.date}&quot; See OSXPhotos Template System in 'osxphotos docs' for more details.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-report">
<span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REPORT_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-report" title="Link to this definition">¶</a></dt>
<dd><p>Write a report of all files that were processed. The extension of the report filename will be used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). REPORT_FILE may be a template string (see OSXPhotos Template System), for example, --report 'push_exif_{today.date}.csv' will write a CSV report file named with today's date. See also --append.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-append">
<span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-append" title="Link to this definition">¶</a></dt>
<dd><p>If used with --report, add data to existing report file instead of overwriting it. See also --report.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-compare">
<span class="sig-name descname"><span class="pre">--compare</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-compare" title="Link to this definition">¶</a></dt>
<dd><p>Compare metadata only; do not push (write) metadata.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-dry-run">
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-dry-run" title="Link to this definition">¶</a></dt>
<dd><p>Dry run mode; show what would be done but do not actually write to any files.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-V">
<span id="cmdoption-osxphotos-push-exif-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-timestamp">
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-timestamp" title="Link to this definition">¶</a></dt>
<dd><p>Add time stamp to verbose output</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-theme">
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-theme" title="Link to this definition">¶</a></dt>
<dd><p>Specify the color theme to use for output. Valid themes are 'dark', 'light', 'mono', and 'plain'. Defaults to 'dark' or 'light' depending on system dark mode setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>dark | light | mono | plain</p>
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-library">
<span id="cmdoption-osxphotos-push-exif-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-keyword">
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;KEYWORD&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with keyword KEYWORD. If more than one keyword, treated as &quot;OR&quot;, e.g. find photos matching any keyword</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-no-keyword">
<span class="sig-name descname"><span class="pre">--no-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-no-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no keyword.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-person">
<span class="sig-name descname"><span class="pre">--person</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PERSON&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-person" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with person PERSON. If more than one person, treated as &quot;OR&quot;, e.g. find photos matching any person</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-album">
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in album ALBUM. If more than one album, treated as &quot;OR&quot;, e.g. find photos matching any album. For albums in a folder, specify the entire folder path, e.g. 'My Folder/My Album'. If album name contains a forward slash, use double slashes to escape it, e.g. 'Travel//2025' for an album named 'Travel/2025'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-folder">
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FOLDER&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-folder" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in an album in folder FOLDER. If more than one folder, treated as &quot;OR&quot;, e.g. find photos in any FOLDER. To search subfolders, specify the entire folder path, e.g. 'My Folder/Subfolder'. If folder name contains a forward slash, use double slashes to escape it, e.g. 'My Folder//Subfolder' for a folder named 'My Folder/Subfolder'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-name">
<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILENAME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-name" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with filename matching FILENAME. If more than one --name options is specified, they are treated as &quot;OR&quot;, e.g. find photos matching any FILENAME.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-uuid">
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-uuid" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-uuid-from-file">
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-uuid-from-file" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is '-', read UUIDs from stdin.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-title">
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TITLE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for TITLE in title of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-no-title">
<span class="sig-name descname"><span class="pre">--no-title</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-no-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no title.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-description">
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DESC&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for DESC in description of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-no-description">
<span class="sig-name descname"><span class="pre">--no-description</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-no-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no description.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-place">
<span class="sig-name descname"><span class="pre">--place</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PLACE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for PLACE in photo's reverse geolocation info</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-no-place">
<span class="sig-name descname"><span class="pre">--no-place</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-no-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated place name info (no reverse geolocation info)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-location">
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with associated location info (e.g. GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-no-location">
<span class="sig-name descname"><span class="pre">--no-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-no-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated location info (e.g. no GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-label">
<span class="sig-name descname"><span class="pre">--label</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;LABEL&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-label" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with image classification label LABEL (Photos 5+ only). If more than one label, treated as &quot;OR&quot;, e.g. find photos matching any label</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-uti">
<span class="sig-name descname"><span class="pre">--uti</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UTI&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-uti" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos whose uniform type identifier (UTI) matches UTI</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-i">
<span id="cmdoption-osxphotos-push-exif-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-i" title="Link to this definition">¶</a></dt>
<dd><p>Case insensitive search when used with other query options.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-edited">
<span class="sig-name descname"><span class="pre">--edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-edited">
<span class="sig-name descname"><span class="pre">--not-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-external-edit">
<span class="sig-name descname"><span class="pre">--external-edit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-external-edit" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos edited in external editor.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-favorite">
<span class="sig-name descname"><span class="pre">--favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-favorite">
<span class="sig-name descname"><span class="pre">--not-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-hidden">
<span class="sig-name descname"><span class="pre">--hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-hidden">
<span class="sig-name descname"><span class="pre">--not-hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-shared">
<span class="sig-name descname"><span class="pre">--shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-shared" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in shared iCloud album (Photos 5+ only).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-shared">
<span class="sig-name descname"><span class="pre">--not-shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-shared" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not in shared iCloud album (Photos 5+ only).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-burst">
<span class="sig-name descname"><span class="pre">--burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were taken in a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-burst">
<span class="sig-name descname"><span class="pre">--not-burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-live">
<span class="sig-name descname"><span class="pre">--live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple live photos</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-live">
<span class="sig-name descname"><span class="pre">--not-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple live photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-portrait">
<span class="sig-name descname"><span class="pre">--portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-portrait">
<span class="sig-name descname"><span class="pre">--not-portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-screenshot">
<span class="sig-name descname"><span class="pre">--screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-screenshot">
<span class="sig-name descname"><span class="pre">--not-screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-screen-recording">
<span class="sig-name descname"><span class="pre">--screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for screen-recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-screen-recording">
<span class="sig-name descname"><span class="pre">--not-screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screen recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-slow-mo">
<span class="sig-name descname"><span class="pre">--slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-slow-mo">
<span class="sig-name descname"><span class="pre">--not-slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-time-lapse">
<span class="sig-name descname"><span class="pre">--time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-time-lapse">
<span class="sig-name descname"><span class="pre">--not-time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-hdr">
<span class="sig-name descname"><span class="pre">--hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for high dynamic range (HDR) photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-hdr">
<span class="sig-name descname"><span class="pre">--not-hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not HDR photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-selfie">
<span class="sig-name descname"><span class="pre">--selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for selfies (photos taken with front-facing cameras).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-selfie">
<span class="sig-name descname"><span class="pre">--not-selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not selfies.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-panorama">
<span class="sig-name descname"><span class="pre">--panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for panorama photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-panorama">
<span class="sig-name descname"><span class="pre">--not-panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not panoramas.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-has-raw">
<span class="sig-name descname"><span class="pre">--has-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-has-raw" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with both a jpeg and raw version</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-only-movies">
<span class="sig-name descname"><span class="pre">--only-movies</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-only-movies" title="Link to this definition">¶</a></dt>
<dd><p>Search only for movies (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-only-photos">
<span class="sig-name descname"><span class="pre">--only-photos</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-only-photos" title="Link to this definition">¶</a></dt>
<dd><p>Search only for photos/images (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-from-date">
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-from-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-to-date">
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-to-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-from-time">
<span class="sig-name descname"><span class="pre">--from-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-from-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after TIME of day, e.g. 12:00, or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-to-time">
<span class="sig-name descname"><span class="pre">--to-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;to_time&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-to-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before TIME of day, e.g. 12:00 or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-year">
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;YEAR&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-year" title="Link to this definition">¶</a></dt>
<dd><p>Search for items from a specific year, e.g. --year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-added-before">
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-added-before" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library before a specific date/time, e.g. --added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-added-after">
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-added-after" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library on or after a specific date/time, e.g. --added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-added-in-last">
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME_DELTA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-added-in-last" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like '12 hrs', '1 day', '1d', '1 week', '2weeks', '1 month', '1 year'. for example, '--added-in-last 7d' and '--added-in-last '1 week'' are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-has-comment">
<span class="sig-name descname"><span class="pre">--has-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-has-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-no-comment">
<span class="sig-name descname"><span class="pre">--no-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-no-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-has-likes">
<span class="sig-name descname"><span class="pre">--has-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-has-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-no-likes">
<span class="sig-name descname"><span class="pre">--no-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-no-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-is-reference">
<span class="sig-name descname"><span class="pre">--is-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-is-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were imported as referenced files (not copied into Photos library).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-reference">
<span class="sig-name descname"><span class="pre">--not-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not references, that is, they were copied into the Photos library and are managed by Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-in-album">
<span class="sig-name descname"><span class="pre">--in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in one or more albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-in-album">
<span class="sig-name descname"><span class="pre">--not-in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in any albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-duplicate">
<span class="sig-name descname"><span class="pre">--duplicate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-duplicate" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with possible duplicates. osxphotos will compare signatures of photos, evaluating date created, size, height, width, and edited status to find <em>possible</em> duplicates. This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple times or duplicated within Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-min-size">
<span class="sig-name descname"><span class="pre">--min-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-min-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &gt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-max-size">
<span class="sig-name descname"><span class="pre">--max-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-max-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &lt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-missing">
<span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos missing from disk.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-missing">
<span class="sig-name descname"><span class="pre">--not-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos present on disk (e.g. not missing).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-cloudasset">
<span class="sig-name descname"><span class="pre">--cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-cloudasset">
<span class="sig-name descname"><span class="pre">--not-cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-incloud">
<span class="sig-name descname"><span class="pre">--incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in iCloud (have been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-incloud">
<span class="sig-name descname"><span class="pre">--not-incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in iCloud (have not been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-syndicated">
<span class="sig-name descname"><span class="pre">--syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-syndicated">
<span class="sig-name descname"><span class="pre">--not-syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-saved-to-library">
<span class="sig-name descname"><span class="pre">--saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-saved-to-library">
<span class="sig-name descname"><span class="pre">--not-saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have not saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-shared-moment">
<span class="sig-name descname"><span class="pre">--shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-shared-moment">
<span class="sig-name descname"><span class="pre">--not-shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-shared-library">
<span class="sig-name descname"><span class="pre">--shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-not-shared-library">
<span class="sig-name descname"><span class="pre">--not-shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-not-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-regex">
<span class="sig-name descname"><span class="pre">--regex</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REGEX</span> <span class="pre">TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-regex" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where TEMPLATE matches regular expression REGEX. For example, to find photos in an album that begins with 'Beach': '--regex &quot;^Beach&quot; &quot;{album}&quot;'. You may specify more than one regular expression match by repeating '--regex' with different arguments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-selected">
<span class="sig-name descname"><span class="pre">--selected</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-selected" title="Link to this definition">¶</a></dt>
<dd><p>Filter for photos that are currently selected in Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-exif">
<span class="sig-name descname"><span class="pre">--exif</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXIF_TAG</span> <span class="pre">VALUE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-exif" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where EXIF_TAG exists in photo's EXIF data and contains VALUE. For example, to find photos created by Adobe Photoshop: '--exif Software 'Adobe Photoshop' 'or to find all photos shot on a Canon camera: '--exif Make Canon'. EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. 'EXIF:Make' or 'Make'. To use --exif, exiftool must be installed and in the path.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-query-eval">
<span class="sig-name descname"><span class="pre">--query-eval</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CRITERIA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-query-eval" title="Link to this definition">¶</a></dt>
<dd><p>Evaluate CRITERIA to filter photos. CRITERIA will be evaluated in context of the following python list comprehension: 'photos = [photo for photo in photos if CRITERIA]' where photo represents a PhotoInfo object. For example: '--query-eval photo.favorite' returns all photos that have been favorited and is equivalent to --favorite. You may specify more than one CRITERIA by using --query-eval multiple times. CRITERIA must be a valid python expression. See <a class="reference external" href="https://rhettbull.github.io/osxphotos/">https://rhettbull.github.io/osxphotos/</a> for additional documentation on the PhotoInfo class.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-push-exif-query-function">
<span class="sig-name descname"><span class="pre">--query-function</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;filename.py:function&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-push-exif-query-function" title="Link to this definition">¶</a></dt>
<dd><p>Run function to filter photos. Use this in format: --query-function filename.py:function where filename.py is a python file you've created and function is the name of the function in the python file you want to call. Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. You may use more than one function by repeating the --query-function option with a different value. Your query function will be called after all other query options have been evaluated. You may also specify a URL to a python file in the format: --query-function https://path/to/module.py::function See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of a query function.</p>
</dd></dl>

</section>
<section id="osxphotos-query">
<h3>query<a class="headerlink" href="#osxphotos-query" title="Link to this heading">¶</a></h3>
<p>Query the Photos database using 1 or more search options;
if more than one different option is provided, they are treated as &quot;AND&quot;
(e.g. search for photos matching all options).
If the same query option is provided multiple times, they are treated as
&quot;OR&quot; (e.g. search for photos matching any of the options).</p>
<p>For example:</p>
<p>osxphotos query --person &quot;John Doe&quot; --person &quot;Jane Doe&quot; --keyword &quot;vacation&quot;</p>
<p>will return all photos with either person of (&quot;John Doe&quot; OR &quot;Jane Doe&quot;) AND keyword of &quot;vacation&quot;</p>
<p>If not query options are provided, all photos in the library will be returned.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>query<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-library">
<span id="cmdoption-osxphotos-query-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-json">
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-json" title="Link to this definition">¶</a></dt>
<dd><p>Print output in JSON format.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-count">
<span class="sig-name descname"><span class="pre">--count</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-count" title="Link to this definition">¶</a></dt>
<dd><p>Print count of photos matching query and exit.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-keyword">
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;KEYWORD&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with keyword KEYWORD. If more than one keyword, treated as &quot;OR&quot;, e.g. find photos matching any keyword</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-keyword">
<span class="sig-name descname"><span class="pre">--no-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no keyword.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-person">
<span class="sig-name descname"><span class="pre">--person</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PERSON&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-person" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with person PERSON. If more than one person, treated as &quot;OR&quot;, e.g. find photos matching any person</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-album">
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in album ALBUM. If more than one album, treated as &quot;OR&quot;, e.g. find photos matching any album. For albums in a folder, specify the entire folder path, e.g. 'My Folder/My Album'. If album name contains a forward slash, use double slashes to escape it, e.g. 'Travel//2025' for an album named 'Travel/2025'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-folder">
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FOLDER&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-folder" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in an album in folder FOLDER. If more than one folder, treated as &quot;OR&quot;, e.g. find photos in any FOLDER. To search subfolders, specify the entire folder path, e.g. 'My Folder/Subfolder'. If folder name contains a forward slash, use double slashes to escape it, e.g. 'My Folder//Subfolder' for a folder named 'My Folder/Subfolder'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-name">
<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILENAME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-name" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with filename matching FILENAME. If more than one --name options is specified, they are treated as &quot;OR&quot;, e.g. find photos matching any FILENAME.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-uuid">
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-uuid" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-uuid-from-file">
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-uuid-from-file" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is '-', read UUIDs from stdin.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-title">
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TITLE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for TITLE in title of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-title">
<span class="sig-name descname"><span class="pre">--no-title</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no title.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-description">
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DESC&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for DESC in description of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-description">
<span class="sig-name descname"><span class="pre">--no-description</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no description.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-place">
<span class="sig-name descname"><span class="pre">--place</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PLACE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for PLACE in photo's reverse geolocation info</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-place">
<span class="sig-name descname"><span class="pre">--no-place</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated place name info (no reverse geolocation info)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-location">
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with associated location info (e.g. GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-location">
<span class="sig-name descname"><span class="pre">--no-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated location info (e.g. no GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-label">
<span class="sig-name descname"><span class="pre">--label</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;LABEL&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-label" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with image classification label LABEL (Photos 5+ only). If more than one label, treated as &quot;OR&quot;, e.g. find photos matching any label</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-uti">
<span class="sig-name descname"><span class="pre">--uti</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UTI&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-uti" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos whose uniform type identifier (UTI) matches UTI</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-i">
<span id="cmdoption-osxphotos-query-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-i" title="Link to this definition">¶</a></dt>
<dd><p>Case insensitive search when used with other query options.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-edited">
<span class="sig-name descname"><span class="pre">--edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-edited">
<span class="sig-name descname"><span class="pre">--not-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-external-edit">
<span class="sig-name descname"><span class="pre">--external-edit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-external-edit" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos edited in external editor.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-favorite">
<span class="sig-name descname"><span class="pre">--favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-favorite">
<span class="sig-name descname"><span class="pre">--not-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-hidden">
<span class="sig-name descname"><span class="pre">--hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-hidden">
<span class="sig-name descname"><span class="pre">--not-hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-shared">
<span class="sig-name descname"><span class="pre">--shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-shared" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in shared iCloud album (Photos 5+ only).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-shared">
<span class="sig-name descname"><span class="pre">--not-shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-shared" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not in shared iCloud album (Photos 5+ only).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-burst">
<span class="sig-name descname"><span class="pre">--burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were taken in a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-burst">
<span class="sig-name descname"><span class="pre">--not-burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-live">
<span class="sig-name descname"><span class="pre">--live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple live photos</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-live">
<span class="sig-name descname"><span class="pre">--not-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple live photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-portrait">
<span class="sig-name descname"><span class="pre">--portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-portrait">
<span class="sig-name descname"><span class="pre">--not-portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-screenshot">
<span class="sig-name descname"><span class="pre">--screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-screenshot">
<span class="sig-name descname"><span class="pre">--not-screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-screen-recording">
<span class="sig-name descname"><span class="pre">--screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for screen-recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-screen-recording">
<span class="sig-name descname"><span class="pre">--not-screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screen recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-slow-mo">
<span class="sig-name descname"><span class="pre">--slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-slow-mo">
<span class="sig-name descname"><span class="pre">--not-slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-time-lapse">
<span class="sig-name descname"><span class="pre">--time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-time-lapse">
<span class="sig-name descname"><span class="pre">--not-time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-hdr">
<span class="sig-name descname"><span class="pre">--hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for high dynamic range (HDR) photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-hdr">
<span class="sig-name descname"><span class="pre">--not-hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not HDR photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-selfie">
<span class="sig-name descname"><span class="pre">--selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for selfies (photos taken with front-facing cameras).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-selfie">
<span class="sig-name descname"><span class="pre">--not-selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not selfies.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-panorama">
<span class="sig-name descname"><span class="pre">--panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for panorama photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-panorama">
<span class="sig-name descname"><span class="pre">--not-panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not panoramas.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-has-raw">
<span class="sig-name descname"><span class="pre">--has-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-has-raw" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with both a jpeg and raw version</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-only-movies">
<span class="sig-name descname"><span class="pre">--only-movies</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-only-movies" title="Link to this definition">¶</a></dt>
<dd><p>Search only for movies (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-only-photos">
<span class="sig-name descname"><span class="pre">--only-photos</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-only-photos" title="Link to this definition">¶</a></dt>
<dd><p>Search only for photos/images (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-from-date">
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-from-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-to-date">
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-to-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-from-time">
<span class="sig-name descname"><span class="pre">--from-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-from-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after TIME of day, e.g. 12:00, or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-to-time">
<span class="sig-name descname"><span class="pre">--to-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;to_time&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-to-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before TIME of day, e.g. 12:00 or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-year">
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;YEAR&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-year" title="Link to this definition">¶</a></dt>
<dd><p>Search for items from a specific year, e.g. --year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-added-before">
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-added-before" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library before a specific date/time, e.g. --added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-added-after">
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-added-after" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library on or after a specific date/time, e.g. --added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-added-in-last">
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME_DELTA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-added-in-last" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like '12 hrs', '1 day', '1d', '1 week', '2weeks', '1 month', '1 year'. for example, '--added-in-last 7d' and '--added-in-last '1 week'' are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-has-comment">
<span class="sig-name descname"><span class="pre">--has-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-has-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-comment">
<span class="sig-name descname"><span class="pre">--no-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-has-likes">
<span class="sig-name descname"><span class="pre">--has-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-has-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-likes">
<span class="sig-name descname"><span class="pre">--no-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-is-reference">
<span class="sig-name descname"><span class="pre">--is-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-is-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were imported as referenced files (not copied into Photos library).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-reference">
<span class="sig-name descname"><span class="pre">--not-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not references, that is, they were copied into the Photos library and are managed by Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-in-album">
<span class="sig-name descname"><span class="pre">--in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in one or more albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-in-album">
<span class="sig-name descname"><span class="pre">--not-in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in any albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-duplicate">
<span class="sig-name descname"><span class="pre">--duplicate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-duplicate" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with possible duplicates. osxphotos will compare signatures of photos, evaluating date created, size, height, width, and edited status to find <em>possible</em> duplicates. This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple times or duplicated within Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-min-size">
<span class="sig-name descname"><span class="pre">--min-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-min-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &gt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-max-size">
<span class="sig-name descname"><span class="pre">--max-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-max-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &lt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-missing">
<span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos missing from disk.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-missing">
<span class="sig-name descname"><span class="pre">--not-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos present on disk (e.g. not missing).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-cloudasset">
<span class="sig-name descname"><span class="pre">--cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-cloudasset">
<span class="sig-name descname"><span class="pre">--not-cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-incloud">
<span class="sig-name descname"><span class="pre">--incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in iCloud (have been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-incloud">
<span class="sig-name descname"><span class="pre">--not-incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in iCloud (have not been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-syndicated">
<span class="sig-name descname"><span class="pre">--syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-syndicated">
<span class="sig-name descname"><span class="pre">--not-syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-saved-to-library">
<span class="sig-name descname"><span class="pre">--saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-saved-to-library">
<span class="sig-name descname"><span class="pre">--not-saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have not saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-shared-moment">
<span class="sig-name descname"><span class="pre">--shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-shared-moment">
<span class="sig-name descname"><span class="pre">--not-shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-shared-library">
<span class="sig-name descname"><span class="pre">--shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-shared-library">
<span class="sig-name descname"><span class="pre">--not-shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-regex">
<span class="sig-name descname"><span class="pre">--regex</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REGEX</span> <span class="pre">TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-regex" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where TEMPLATE matches regular expression REGEX. For example, to find photos in an album that begins with 'Beach': '--regex &quot;^Beach&quot; &quot;{album}&quot;'. You may specify more than one regular expression match by repeating '--regex' with different arguments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-selected">
<span class="sig-name descname"><span class="pre">--selected</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-selected" title="Link to this definition">¶</a></dt>
<dd><p>Filter for photos that are currently selected in Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-exif">
<span class="sig-name descname"><span class="pre">--exif</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXIF_TAG</span> <span class="pre">VALUE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-exif" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where EXIF_TAG exists in photo's EXIF data and contains VALUE. For example, to find photos created by Adobe Photoshop: '--exif Software 'Adobe Photoshop' 'or to find all photos shot on a Canon camera: '--exif Make Canon'. EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. 'EXIF:Make' or 'Make'. To use --exif, exiftool must be installed and in the path.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-query-eval">
<span class="sig-name descname"><span class="pre">--query-eval</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CRITERIA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-query-eval" title="Link to this definition">¶</a></dt>
<dd><p>Evaluate CRITERIA to filter photos. CRITERIA will be evaluated in context of the following python list comprehension: 'photos = [photo for photo in photos if CRITERIA]' where photo represents a PhotoInfo object. For example: '--query-eval photo.favorite' returns all photos that have been favorited and is equivalent to --favorite. You may specify more than one CRITERIA by using --query-eval multiple times. CRITERIA must be a valid python expression. See <a class="reference external" href="https://rhettbull.github.io/osxphotos/">https://rhettbull.github.io/osxphotos/</a> for additional documentation on the PhotoInfo class.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-query-function">
<span class="sig-name descname"><span class="pre">--query-function</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;filename.py:function&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-query-function" title="Link to this definition">¶</a></dt>
<dd><p>Run function to filter photos. Use this in format: --query-function filename.py:function where filename.py is a python file you've created and function is the name of the function in the python file you want to call. Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. You may use more than one function by repeating the --query-function option with a different value. Your query function will be called after all other query options have been evaluated. You may also specify a URL to a python file in the format: --query-function https://path/to/module.py::function See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of a query function.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-deleted-only">
<span class="sig-name descname"><span class="pre">--deleted-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-deleted-only" title="Link to this definition">¶</a></dt>
<dd><p>Include only photos from the 'Recently Deleted' folder.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-deleted">
<span class="sig-name descname"><span class="pre">--deleted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-deleted" title="Link to this definition">¶</a></dt>
<dd><p>Include photos from the 'Recently Deleted' folder.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-add-to-album">
<span class="sig-name descname"><span class="pre">--add-to-album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-add-to-album" title="Link to this definition">¶</a></dt>
<dd><p>Add all photos from query to album ALBUM in Photos. Album ALBUM will be created if it doesn't exist.  All photos in the query results will be added to this album. This only works if the Photos library being queried is the last-opened (default) library in Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-quiet">
<span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-quiet" title="Link to this definition">¶</a></dt>
<dd><p>Quiet output; doesn't actually print query results. Useful with --print and --add-to-album if you don't want to see the actual query results.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-f">
<span id="cmdoption-osxphotos-query-field"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--field</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FIELD</span> <span class="pre">TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-f" title="Link to this definition">¶</a></dt>
<dd><p>Output only specified custom fields. FIELD is the name of the field and TEMPLATE is the template to use as the field value. May be repeated to output multiple fields. For example, to output photo uuid, name, and title: '--field uuid &quot;{uuid}&quot; --field name &quot;{original_name}&quot; --field title &quot;{title}&quot;'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-print">
<span class="sig-name descname"><span class="pre">--print</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-query-print" title="Link to this definition">¶</a></dt>
<dd><p>Render TEMPLATE string for each photo queried and print to stdout. TEMPLATE is an osxphotos template string. This may be useful for creating custom reports, etc. Most useful with --quiet. May be repeated to print multiple template strings.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-mute">
<span class="sig-name descname"><span class="pre">--mute</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-mute" title="Link to this definition">¶</a></dt>
<dd><p>Mute status output while loading Photos library.</p>
</dd></dl>

</section>
<section id="osxphotos-repl">
<h3>repl<a class="headerlink" href="#osxphotos-repl" title="Link to this heading">¶</a></h3>
<p>Run interactive osxphotos REPL shell (useful for debugging, prototyping, and inspecting your Photos library)</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>repl<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-library">
<span id="cmdoption-osxphotos-repl-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-emacs">
<span class="sig-name descname"><span class="pre">--emacs</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-emacs" title="Link to this definition">¶</a></dt>
<dd><p>Launch REPL with Emacs keybindings (default is vi bindings)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-keyword">
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;KEYWORD&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with keyword KEYWORD. If more than one keyword, treated as &quot;OR&quot;, e.g. find photos matching any keyword</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-keyword">
<span class="sig-name descname"><span class="pre">--no-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no keyword.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-person">
<span class="sig-name descname"><span class="pre">--person</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PERSON&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-person" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with person PERSON. If more than one person, treated as &quot;OR&quot;, e.g. find photos matching any person</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-album">
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in album ALBUM. If more than one album, treated as &quot;OR&quot;, e.g. find photos matching any album. For albums in a folder, specify the entire folder path, e.g. 'My Folder/My Album'. If album name contains a forward slash, use double slashes to escape it, e.g. 'Travel//2025' for an album named 'Travel/2025'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-folder">
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FOLDER&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-folder" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in an album in folder FOLDER. If more than one folder, treated as &quot;OR&quot;, e.g. find photos in any FOLDER. To search subfolders, specify the entire folder path, e.g. 'My Folder/Subfolder'. If folder name contains a forward slash, use double slashes to escape it, e.g. 'My Folder//Subfolder' for a folder named 'My Folder/Subfolder'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-name">
<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILENAME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-name" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with filename matching FILENAME. If more than one --name options is specified, they are treated as &quot;OR&quot;, e.g. find photos matching any FILENAME.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-uuid">
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-uuid" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-uuid-from-file">
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-uuid-from-file" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is '-', read UUIDs from stdin.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-title">
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TITLE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for TITLE in title of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-title">
<span class="sig-name descname"><span class="pre">--no-title</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no title.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-description">
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DESC&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for DESC in description of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-description">
<span class="sig-name descname"><span class="pre">--no-description</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no description.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-place">
<span class="sig-name descname"><span class="pre">--place</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PLACE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for PLACE in photo's reverse geolocation info</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-place">
<span class="sig-name descname"><span class="pre">--no-place</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated place name info (no reverse geolocation info)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-location">
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with associated location info (e.g. GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-location">
<span class="sig-name descname"><span class="pre">--no-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated location info (e.g. no GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-label">
<span class="sig-name descname"><span class="pre">--label</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;LABEL&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-label" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with image classification label LABEL (Photos 5+ only). If more than one label, treated as &quot;OR&quot;, e.g. find photos matching any label</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-uti">
<span class="sig-name descname"><span class="pre">--uti</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UTI&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-uti" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos whose uniform type identifier (UTI) matches UTI</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-i">
<span id="cmdoption-osxphotos-repl-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-i" title="Link to this definition">¶</a></dt>
<dd><p>Case insensitive search when used with other query options.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-edited">
<span class="sig-name descname"><span class="pre">--edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-edited">
<span class="sig-name descname"><span class="pre">--not-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-external-edit">
<span class="sig-name descname"><span class="pre">--external-edit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-external-edit" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos edited in external editor.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-favorite">
<span class="sig-name descname"><span class="pre">--favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-favorite">
<span class="sig-name descname"><span class="pre">--not-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-hidden">
<span class="sig-name descname"><span class="pre">--hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-hidden">
<span class="sig-name descname"><span class="pre">--not-hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-shared">
<span class="sig-name descname"><span class="pre">--shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-shared" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in shared iCloud album (Photos 5+ only).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-shared">
<span class="sig-name descname"><span class="pre">--not-shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-shared" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not in shared iCloud album (Photos 5+ only).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-burst">
<span class="sig-name descname"><span class="pre">--burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were taken in a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-burst">
<span class="sig-name descname"><span class="pre">--not-burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-live">
<span class="sig-name descname"><span class="pre">--live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple live photos</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-live">
<span class="sig-name descname"><span class="pre">--not-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple live photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-portrait">
<span class="sig-name descname"><span class="pre">--portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-portrait">
<span class="sig-name descname"><span class="pre">--not-portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-screenshot">
<span class="sig-name descname"><span class="pre">--screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-screenshot">
<span class="sig-name descname"><span class="pre">--not-screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-screen-recording">
<span class="sig-name descname"><span class="pre">--screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for screen-recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-screen-recording">
<span class="sig-name descname"><span class="pre">--not-screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screen recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-slow-mo">
<span class="sig-name descname"><span class="pre">--slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-slow-mo">
<span class="sig-name descname"><span class="pre">--not-slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-time-lapse">
<span class="sig-name descname"><span class="pre">--time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-time-lapse">
<span class="sig-name descname"><span class="pre">--not-time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-hdr">
<span class="sig-name descname"><span class="pre">--hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for high dynamic range (HDR) photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-hdr">
<span class="sig-name descname"><span class="pre">--not-hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not HDR photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-selfie">
<span class="sig-name descname"><span class="pre">--selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for selfies (photos taken with front-facing cameras).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-selfie">
<span class="sig-name descname"><span class="pre">--not-selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not selfies.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-panorama">
<span class="sig-name descname"><span class="pre">--panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for panorama photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-panorama">
<span class="sig-name descname"><span class="pre">--not-panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not panoramas.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-has-raw">
<span class="sig-name descname"><span class="pre">--has-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-has-raw" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with both a jpeg and raw version</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-only-movies">
<span class="sig-name descname"><span class="pre">--only-movies</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-only-movies" title="Link to this definition">¶</a></dt>
<dd><p>Search only for movies (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-only-photos">
<span class="sig-name descname"><span class="pre">--only-photos</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-only-photos" title="Link to this definition">¶</a></dt>
<dd><p>Search only for photos/images (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-from-date">
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-from-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-to-date">
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-to-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-from-time">
<span class="sig-name descname"><span class="pre">--from-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-from-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after TIME of day, e.g. 12:00, or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-to-time">
<span class="sig-name descname"><span class="pre">--to-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;to_time&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-to-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before TIME of day, e.g. 12:00 or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-year">
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;YEAR&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-year" title="Link to this definition">¶</a></dt>
<dd><p>Search for items from a specific year, e.g. --year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-added-before">
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-added-before" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library before a specific date/time, e.g. --added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-added-after">
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-added-after" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library on or after a specific date/time, e.g. --added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-added-in-last">
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME_DELTA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-added-in-last" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like '12 hrs', '1 day', '1d', '1 week', '2weeks', '1 month', '1 year'. for example, '--added-in-last 7d' and '--added-in-last '1 week'' are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-has-comment">
<span class="sig-name descname"><span class="pre">--has-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-has-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-comment">
<span class="sig-name descname"><span class="pre">--no-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-has-likes">
<span class="sig-name descname"><span class="pre">--has-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-has-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-likes">
<span class="sig-name descname"><span class="pre">--no-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-is-reference">
<span class="sig-name descname"><span class="pre">--is-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-is-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were imported as referenced files (not copied into Photos library).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-reference">
<span class="sig-name descname"><span class="pre">--not-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not references, that is, they were copied into the Photos library and are managed by Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-in-album">
<span class="sig-name descname"><span class="pre">--in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in one or more albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-in-album">
<span class="sig-name descname"><span class="pre">--not-in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in any albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-duplicate">
<span class="sig-name descname"><span class="pre">--duplicate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-duplicate" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with possible duplicates. osxphotos will compare signatures of photos, evaluating date created, size, height, width, and edited status to find <em>possible</em> duplicates. This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple times or duplicated within Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-min-size">
<span class="sig-name descname"><span class="pre">--min-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-min-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &gt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-max-size">
<span class="sig-name descname"><span class="pre">--max-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-max-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &lt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-missing">
<span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos missing from disk.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-missing">
<span class="sig-name descname"><span class="pre">--not-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos present on disk (e.g. not missing).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-cloudasset">
<span class="sig-name descname"><span class="pre">--cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-cloudasset">
<span class="sig-name descname"><span class="pre">--not-cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-incloud">
<span class="sig-name descname"><span class="pre">--incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in iCloud (have been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-incloud">
<span class="sig-name descname"><span class="pre">--not-incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in iCloud (have not been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-syndicated">
<span class="sig-name descname"><span class="pre">--syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-syndicated">
<span class="sig-name descname"><span class="pre">--not-syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-saved-to-library">
<span class="sig-name descname"><span class="pre">--saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-saved-to-library">
<span class="sig-name descname"><span class="pre">--not-saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have not saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-shared-moment">
<span class="sig-name descname"><span class="pre">--shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-shared-moment">
<span class="sig-name descname"><span class="pre">--not-shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-shared-library">
<span class="sig-name descname"><span class="pre">--shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-shared-library">
<span class="sig-name descname"><span class="pre">--not-shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-regex">
<span class="sig-name descname"><span class="pre">--regex</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REGEX</span> <span class="pre">TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-regex" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where TEMPLATE matches regular expression REGEX. For example, to find photos in an album that begins with 'Beach': '--regex &quot;^Beach&quot; &quot;{album}&quot;'. You may specify more than one regular expression match by repeating '--regex' with different arguments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-selected">
<span class="sig-name descname"><span class="pre">--selected</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-selected" title="Link to this definition">¶</a></dt>
<dd><p>Filter for photos that are currently selected in Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-exif">
<span class="sig-name descname"><span class="pre">--exif</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXIF_TAG</span> <span class="pre">VALUE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-exif" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where EXIF_TAG exists in photo's EXIF data and contains VALUE. For example, to find photos created by Adobe Photoshop: '--exif Software 'Adobe Photoshop' 'or to find all photos shot on a Canon camera: '--exif Make Canon'. EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. 'EXIF:Make' or 'Make'. To use --exif, exiftool must be installed and in the path.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-query-eval">
<span class="sig-name descname"><span class="pre">--query-eval</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CRITERIA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-query-eval" title="Link to this definition">¶</a></dt>
<dd><p>Evaluate CRITERIA to filter photos. CRITERIA will be evaluated in context of the following python list comprehension: 'photos = [photo for photo in photos if CRITERIA]' where photo represents a PhotoInfo object. For example: '--query-eval photo.favorite' returns all photos that have been favorited and is equivalent to --favorite. You may specify more than one CRITERIA by using --query-eval multiple times. CRITERIA must be a valid python expression. See <a class="reference external" href="https://rhettbull.github.io/osxphotos/">https://rhettbull.github.io/osxphotos/</a> for additional documentation on the PhotoInfo class.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-query-function">
<span class="sig-name descname"><span class="pre">--query-function</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;filename.py:function&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-query-function" title="Link to this definition">¶</a></dt>
<dd><p>Run function to filter photos. Use this in format: --query-function filename.py:function where filename.py is a python file you've created and function is the name of the function in the python file you want to call. Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. You may use more than one function by repeating the --query-function option with a different value. Your query function will be called after all other query options have been evaluated. You may also specify a URL to a python file in the format: --query-function https://path/to/module.py::function See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of a query function.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-deleted-only">
<span class="sig-name descname"><span class="pre">--deleted-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-deleted-only" title="Link to this definition">¶</a></dt>
<dd><p>Include only photos from the 'Recently Deleted' folder.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-deleted">
<span class="sig-name descname"><span class="pre">--deleted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-deleted" title="Link to this definition">¶</a></dt>
<dd><p>Include photos from the 'Recently Deleted' folder.</p>
</dd></dl>

</section>
<section id="osxphotos-run">
<h3>run<a class="headerlink" href="#osxphotos-run" title="Link to this heading">¶</a></h3>
<p>Run a python file using same environment as osxphotos.
Any args are made available to the python file.</p>
<p>The python file may be a path on disk, 'osxphotos run /path/to/file.py'
or a URL to a python file, for example,</p>
<p>'osxphotos run <a class="reference external" href="https://raw.githubusercontent.com/RhetTbull/osxphotos/main/examples/count_photos.py">https://raw.githubusercontent.com/RhetTbull/osxphotos/main/examples/count_photos.py</a>'</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>run<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>PYTHON_FILE<span class="w"> </span>ARGS
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-run-h">
<span id="cmdoption-osxphotos-run-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-run-h" title="Link to this definition">¶</a></dt>
<dd><p>Show this message and exit.</p>
</dd></dl>

</section>
<section id="osxphotos-show">
<h3>show<a class="headerlink" href="#osxphotos-show" title="Link to this heading">¶</a></h3>
<p>Show photo, album, or folder in Photos from UUID_OR_NAME</p>
<p>Examples:</p>
<p>osxphotos show 12345678-1234-1234-1234-123456789012</p>
<p>osxphotos show &quot;My Album&quot;</p>
<p>osxphotos show &quot;My Folder&quot;</p>
<p>osxphotos show IMG_1234.JPG</p>
<p>show can also be used to show a photo exported with 'osxphotos export':</p>
<p>osxphotos show /path/to/exported/photo.jpg</p>
<p>In this case, the UUID_OR_NAME is the path to the exported photo and osxphotos
will attempt to find the export database to match the photo to the original in
Photos. If your export database is not in the default location in the root of the
export directory, this will not work.</p>
<p>Notes:</p>
<p>This command requires Photos library version 5 or higher.
Currently this command cannot be used to show subfolders in Photos.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>show<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>UUID_OR_NAME
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-show-library">
<span id="cmdoption-osxphotos-show-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-show-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-show-arg-UUID_OR_NAME">
<span class="sig-name descname"><span class="pre">UUID_OR_NAME</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-show-arg-UUID_OR_NAME" title="Link to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>

</section>
<section id="osxphotos-sync">
<h3>sync<a class="headerlink" href="#osxphotos-sync" title="Link to this heading">¶</a></h3>
<p>Sync metadata and albums between Photos libraries.</p>
<p>Use sync to update metadata in a local Photos library to match
metadata in another Photos library. The sync command works by
finding identical photos in the local library and the import source
and then updating the metadata in the local library to match the
metadata in the import source. Photos are considered identical if
their original filename and fingerprint match.</p>
<p>The import source can be a Photos library or a metadata export file
created with the --export option.</p>
<p>The sync command can be useful if you have imported the same photos to
multiple Photos libraries and want to keep the metadata in all libraries
in sync.</p>
<p>Metadata can be overwritten (--set) or merged (--merge) with the metadata
in the import source. You may specify specific metadata to sync or sync
all metadata. See --set and --merge for more details.</p>
<p>The sync command can be used to sync metadata between an iPhone or iPad
and a Mac, for example, in the case where you do not use iCloud but
manually import photos from your iPhone or iPad to your Mac. To do this,
you'll first need to copy the Photos database from the iPhone or iPad to
your Mac. This can be done by connecting your iPhone or iPad to your Mac
using a USB cable and then copying the Photos database from the iPhone
using a third-party tool such as iMazing (<a class="reference external" href="https://imazing.com/">https://imazing.com/</a>). You can
then use the sync command and set the import source to the Photos database
you copied from the iPhone or iPad.</p>
<p>The sync command can also be used to sync metadata between users using
iCloud Shared Photo Library. NOTE: This use case has not yet been
tested. If you use iCloud Shared Photo Library and would like to help
test this use case, please connect with me on GitHub:
<a class="reference external" href="https://github.com/RhetTbull/osxphotos/issues/887">https://github.com/RhetTbull/osxphotos/issues/887</a></p>
<p>You can run the --export and --import commands together. In this case,
the import will be run first and then the export will be run.</p>
<p>For example, if you want to sync two Photos libraries between users or
two different computers, you can export the metadata to a shared folder.</p>
<p>On the first computer, run:</p>
<p>osxphotos sync --export /path/to/export/folder/computer1.db --merge all --import /path/to/export/folder/computer2.db</p>
<p>On the second computer, run:</p>
<p>osxphotos sync --export /path/to/export/folder/computer2.db --merge all --import /path/to/export/folder/computer1.db</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>sync<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-e">
<span id="cmdoption-osxphotos-sync-export"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--export</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXPORT_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-e" title="Link to this definition">¶</a></dt>
<dd><p>Export metadata to file EXPORT_FILE for later use with --import. The export file will be a SQLite database; it is recommended to use the .db extension though this is not required.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-I">
<span id="cmdoption-osxphotos-sync-import"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--import</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;IMPORT_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-I" title="Link to this definition">¶</a></dt>
<dd><p>Import metadata from file IMPORT_PATH. IMPORT_PATH can a Photos library, a Photos database, or a metadata export file created with --export.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-s">
<span id="cmdoption-osxphotos-sync-set"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--set</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;METADATA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-s" title="Link to this definition">¶</a></dt>
<dd><p>When used with --import, set metadata in local Photos library to match import data. Multiple metadata properties can be specified by repeating the --set option or by using a comma-separated list. METADATA can be one of: all, keywords, albums, title, description, favorite, location. For example, to set keywords and favorite, use '--set keywords --set favorite' or '--set keywords,favorite'. If '--set all' is specified, all metadata will be set. Note that using --set overwrites any existing metadata in the local Photos library. For example, if a photo is marked as favorite in the local library but not in the import source, --set favorite will clear the favorite status in the local library. The exception to this is that '--set albums' will not remove the photo from any existing albums in the local library but will add the photo to any new albums specified in the import source.See also --merge.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-m">
<span id="cmdoption-osxphotos-sync-merge"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--merge</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;METADATA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-m" title="Link to this definition">¶</a></dt>
<dd><p>When used with --import, merge metadata in local Photos library with import data. Multiple metadata properties can be specified by repeating the --merge option or by using a comma-separated list. METADATA can be one of: all, keywords, albums, title, description, favorite, location. For example, to merge keywords and favorite, use '--merge keywords --merge favorite' or '--merge keywords,favorite'. If '--merge all' is specified, all metadata will be merged. Note that using --merge does not overwrite any existing metadata in the local Photos library. For example, if a photo is marked as favorite in the local library but not in the import source, --merge favorite will not change the favorite status in the local library. See also --set.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-U">
<span id="cmdoption-osxphotos-sync-unmatched"></span><span class="sig-name descname"><span class="pre">-U</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--unmatched</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-U" title="Link to this definition">¶</a></dt>
<dd><p>When used with --import, print out a list of photos in the import source that were not matched against the local library. Also prints out a list of photos in the local library that were not matched against the import source.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-R">
<span id="cmdoption-osxphotos-sync-report"></span><span class="sig-name descname"><span class="pre">-R</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REPORT_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-R" title="Link to this definition">¶</a></dt>
<dd><p>Write a report of all photos that were processed with --import. The extension of the report filename will be used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). REPORT_FILE may be a an osxphotos template string, for example, --report 'update_{today.date}.csv' will write a CSV report file named with today's date. See also --append.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-A">
<span id="cmdoption-osxphotos-sync-append"></span><span class="sig-name descname"><span class="pre">-A</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-A" title="Link to this definition">¶</a></dt>
<dd><p>If used with --report, add data to existing report file instead of overwriting it. See also --report.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-dry-run">
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-dry-run" title="Link to this definition">¶</a></dt>
<dd><p>Dry run; when used with --import, don't actually update metadata.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-V">
<span id="cmdoption-osxphotos-sync-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-timestamp">
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-timestamp" title="Link to this definition">¶</a></dt>
<dd><p>Add time stamp to verbose output</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-keyword">
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;KEYWORD&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with keyword KEYWORD. If more than one keyword, treated as &quot;OR&quot;, e.g. find photos matching any keyword</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-keyword">
<span class="sig-name descname"><span class="pre">--no-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-keyword" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no keyword.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-person">
<span class="sig-name descname"><span class="pre">--person</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PERSON&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-person" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with person PERSON. If more than one person, treated as &quot;OR&quot;, e.g. find photos matching any person</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-album">
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in album ALBUM. If more than one album, treated as &quot;OR&quot;, e.g. find photos matching any album. For albums in a folder, specify the entire folder path, e.g. 'My Folder/My Album'. If album name contains a forward slash, use double slashes to escape it, e.g. 'Travel//2025' for an album named 'Travel/2025'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-folder">
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FOLDER&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-folder" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in an album in folder FOLDER. If more than one folder, treated as &quot;OR&quot;, e.g. find photos in any FOLDER. To search subfolders, specify the entire folder path, e.g. 'My Folder/Subfolder'. If folder name contains a forward slash, use double slashes to escape it, e.g. 'My Folder//Subfolder' for a folder named 'My Folder/Subfolder'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-name">
<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILENAME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-name" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with filename matching FILENAME. If more than one --name options is specified, they are treated as &quot;OR&quot;, e.g. find photos matching any FILENAME.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-uuid">
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-uuid" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-uuid-from-file">
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-uuid-from-file" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is '-', read UUIDs from stdin.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-title">
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TITLE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for TITLE in title of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-title">
<span class="sig-name descname"><span class="pre">--no-title</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-title" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no title.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-description">
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DESC&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for DESC in description of photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-description">
<span class="sig-name descname"><span class="pre">--no-description</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-description" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no description.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-place">
<span class="sig-name descname"><span class="pre">--place</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PLACE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for PLACE in photo's reverse geolocation info</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-place">
<span class="sig-name descname"><span class="pre">--no-place</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-place" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated place name info (no reverse geolocation info)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-location">
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with associated location info (e.g. GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-location">
<span class="sig-name descname"><span class="pre">--no-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-location" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no associated location info (e.g. no GPS coordinates)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-label">
<span class="sig-name descname"><span class="pre">--label</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;LABEL&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-label" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with image classification label LABEL (Photos 5+ only). If more than one label, treated as &quot;OR&quot;, e.g. find photos matching any label</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-uti">
<span class="sig-name descname"><span class="pre">--uti</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UTI&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-uti" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos whose uniform type identifier (UTI) matches UTI</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-i">
<span id="cmdoption-osxphotos-sync-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-i" title="Link to this definition">¶</a></dt>
<dd><p>Case insensitive search when used with other query options.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-edited">
<span class="sig-name descname"><span class="pre">--edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-edited">
<span class="sig-name descname"><span class="pre">--not-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-edited" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been edited.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-external-edit">
<span class="sig-name descname"><span class="pre">--external-edit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-external-edit" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos edited in external editor.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-favorite">
<span class="sig-name descname"><span class="pre">--favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-favorite">
<span class="sig-name descname"><span class="pre">--not-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-favorite" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked favorite.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-hidden">
<span class="sig-name descname"><span class="pre">--hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-hidden">
<span class="sig-name descname"><span class="pre">--not-hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-hidden" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos not marked hidden.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-burst">
<span class="sig-name descname"><span class="pre">--burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were taken in a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-burst">
<span class="sig-name descname"><span class="pre">--not-burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-burst" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a burst.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-live">
<span class="sig-name descname"><span class="pre">--live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple live photos</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-live">
<span class="sig-name descname"><span class="pre">--not-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-live" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple live photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-portrait">
<span class="sig-name descname"><span class="pre">--portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-portrait">
<span class="sig-name descname"><span class="pre">--not-portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-portrait" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not Apple portrait mode photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-screenshot">
<span class="sig-name descname"><span class="pre">--screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-screenshot">
<span class="sig-name descname"><span class="pre">--not-screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screenshot photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-screen-recording">
<span class="sig-name descname"><span class="pre">--screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for screen-recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-screen-recording">
<span class="sig-name descname"><span class="pre">--not-screen-recording</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-screen-recording" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not screen recording videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-slow-mo">
<span class="sig-name descname"><span class="pre">--slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-slow-mo">
<span class="sig-name descname"><span class="pre">--not-slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-slow-mo" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not slow motion videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-time-lapse">
<span class="sig-name descname"><span class="pre">--time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-time-lapse">
<span class="sig-name descname"><span class="pre">--not-time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-time-lapse" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not time lapse videos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-hdr">
<span class="sig-name descname"><span class="pre">--hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for high dynamic range (HDR) photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-hdr">
<span class="sig-name descname"><span class="pre">--not-hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-hdr" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not HDR photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-selfie">
<span class="sig-name descname"><span class="pre">--selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for selfies (photos taken with front-facing cameras).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-selfie">
<span class="sig-name descname"><span class="pre">--not-selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-selfie" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not selfies.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-panorama">
<span class="sig-name descname"><span class="pre">--panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for panorama photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-panorama">
<span class="sig-name descname"><span class="pre">--not-panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-panorama" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not panoramas.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-has-raw">
<span class="sig-name descname"><span class="pre">--has-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-has-raw" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with both a jpeg and raw version</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-only-movies">
<span class="sig-name descname"><span class="pre">--only-movies</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-only-movies" title="Link to this definition">¶</a></dt>
<dd><p>Search only for movies (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-only-photos">
<span class="sig-name descname"><span class="pre">--only-photos</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-only-photos" title="Link to this definition">¶</a></dt>
<dd><p>Search only for photos/images (default searches both images and movies).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-from-date">
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-from-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-to-date">
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-to-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-from-time">
<span class="sig-name descname"><span class="pre">--from-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-from-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after TIME of day, e.g. 12:00, or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-to-time">
<span class="sig-name descname"><span class="pre">--to-time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;to_time&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-to-time" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before TIME of day, e.g. 12:00 or 12:00:00.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-year">
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;YEAR&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-year" title="Link to this definition">¶</a></dt>
<dd><p>Search for items from a specific year, e.g. --year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-added-before">
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-added-before" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library before a specific date/time, e.g. --added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-added-after">
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-added-after" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library on or after a specific date/time, e.g. --added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-added-in-last">
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME_DELTA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-added-in-last" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like '12 hrs', '1 day', '1d', '1 week', '2weeks', '1 month', '1 year'. for example, '--added-in-last 7d' and '--added-in-last '1 week'' are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-has-comment">
<span class="sig-name descname"><span class="pre">--has-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-has-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-comment">
<span class="sig-name descname"><span class="pre">--no-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-comment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no comments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-has-likes">
<span class="sig-name descname"><span class="pre">--has-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-has-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-likes">
<span class="sig-name descname"><span class="pre">--no-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-likes" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with no likes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-is-reference">
<span class="sig-name descname"><span class="pre">--is-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-is-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that were imported as referenced files (not copied into Photos library).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-reference">
<span class="sig-name descname"><span class="pre">--not-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-reference" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not references, that is, they were copied into the Photos library and are managed by Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-in-album">
<span class="sig-name descname"><span class="pre">--in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in one or more albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-in-album">
<span class="sig-name descname"><span class="pre">--not-in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-in-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in any albums.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-duplicate">
<span class="sig-name descname"><span class="pre">--duplicate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-duplicate" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with possible duplicates. osxphotos will compare signatures of photos, evaluating date created, size, height, width, and edited status to find <em>possible</em> duplicates. This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple times or duplicated within Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-min-size">
<span class="sig-name descname"><span class="pre">--min-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-min-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &gt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-max-size">
<span class="sig-name descname"><span class="pre">--max-size</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;SIZE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-max-size" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with size &lt;= SIZE bytes. The size evaluated is the photo's original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-missing">
<span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos missing from disk.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-missing">
<span class="sig-name descname"><span class="pre">--not-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-missing" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos present on disk (e.g. not missing).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-cloudasset">
<span class="sig-name descname"><span class="pre">--cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-cloudasset">
<span class="sig-name descname"><span class="pre">--not-cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of an iCloud library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-incloud">
<span class="sig-name descname"><span class="pre">--incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are in iCloud (have been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-incloud">
<span class="sig-name descname"><span class="pre">--not-incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-incloud" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not in iCloud (have not been synched)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-syndicated">
<span class="sig-name descname"><span class="pre">--syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-syndicated">
<span class="sig-name descname"><span class="pre">--not-syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that have not been shared via syndication ('Shared with You' album via Messages, etc.)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-saved-to-library">
<span class="sig-name descname"><span class="pre">--saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-saved-to-library">
<span class="sig-name descname"><span class="pre">--not-saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-saved-to-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for syndicated photos that have not saved to the library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-shared-moment">
<span class="sig-name descname"><span class="pre">--shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-shared-moment">
<span class="sig-name descname"><span class="pre">--not-shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-shared-moment" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared moment</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-shared-library">
<span class="sig-name descname"><span class="pre">--shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-shared-library">
<span class="sig-name descname"><span class="pre">--not-shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-shared-library" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos that are not part of a shared library</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-regex">
<span class="sig-name descname"><span class="pre">--regex</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REGEX</span> <span class="pre">TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-regex" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where TEMPLATE matches regular expression REGEX. For example, to find photos in an album that begins with 'Beach': '--regex &quot;^Beach&quot; &quot;{album}&quot;'. You may specify more than one regular expression match by repeating '--regex' with different arguments.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-selected">
<span class="sig-name descname"><span class="pre">--selected</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-selected" title="Link to this definition">¶</a></dt>
<dd><p>Filter for photos that are currently selected in Photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-exif">
<span class="sig-name descname"><span class="pre">--exif</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;EXIF_TAG</span> <span class="pre">VALUE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-exif" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos where EXIF_TAG exists in photo's EXIF data and contains VALUE. For example, to find photos created by Adobe Photoshop: '--exif Software 'Adobe Photoshop' 'or to find all photos shot on a Canon camera: '--exif Make Canon'. EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. 'EXIF:Make' or 'Make'. To use --exif, exiftool must be installed and in the path.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-query-eval">
<span class="sig-name descname"><span class="pre">--query-eval</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;CRITERIA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-query-eval" title="Link to this definition">¶</a></dt>
<dd><p>Evaluate CRITERIA to filter photos. CRITERIA will be evaluated in context of the following python list comprehension: 'photos = [photo for photo in photos if CRITERIA]' where photo represents a PhotoInfo object. For example: '--query-eval photo.favorite' returns all photos that have been favorited and is equivalent to --favorite. You may specify more than one CRITERIA by using --query-eval multiple times. CRITERIA must be a valid python expression. See <a class="reference external" href="https://rhettbull.github.io/osxphotos/">https://rhettbull.github.io/osxphotos/</a> for additional documentation on the PhotoInfo class.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-query-function">
<span class="sig-name descname"><span class="pre">--query-function</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;filename.py:function&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-query-function" title="Link to this definition">¶</a></dt>
<dd><p>Run function to filter photos. Use this in format: --query-function filename.py:function where filename.py is a python file you've created and function is the name of the function in the python file you want to call. Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. You may use more than one function by repeating the --query-function option with a different value. Your query function will be called after all other query options have been evaluated. You may also specify a URL to a python file in the format: --query-function https://path/to/module.py::function See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of a query function.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-library">
<span id="cmdoption-osxphotos-sync-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-theme">
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-theme" title="Link to this definition">¶</a></dt>
<dd><p>Specify the color theme to use for output. Valid themes are 'dark', 'light', 'mono', and 'plain'. Defaults to 'dark' or 'light' depending on system dark mode setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>dark | light | mono | plain</p>
</dd>
</dl>
</dd></dl>

</section>
<section id="osxphotos-template">
<h3>template<a class="headerlink" href="#osxphotos-template" title="Link to this heading">¶</a></h3>
<p>Interactively render templates for selected photo.</p>
<p>Launches a REPL (Read-Eval-Print-Loop) to interactively render a template for the selected photo.</p>
<p>Select a photo in Photos then run 'osxphotos template' to start the REPL.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>template<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-template-T">
<span id="cmdoption-osxphotos-template-template"></span><span class="sig-name descname"><span class="pre">-T</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--template</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TEMPLATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-template-T" title="Link to this definition">¶</a></dt>
<dd><p>Template string to render for selected photo. If --template/-T is used, the template will be rendered and printed and the REPL will not be started. Multiple templates may be specified by repeating --template/-T.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-template-uuid">
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-template-uuid" title="Link to this definition">¶</a></dt>
<dd><p>Use photo with uuid UUID to render template inplace of selected photo.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-template-library">
<span id="cmdoption-osxphotos-template-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-template-library" title="Link to this definition">¶</a></dt>
<dd><p>Specify path to Photos library. If not provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-template-vi">
<span class="sig-name descname"><span class="pre">--vi</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-template-vi" title="Link to this definition">¶</a></dt>
<dd><p>Use vi keybindings.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-template-emacs">
<span class="sig-name descname"><span class="pre">--emacs</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-template-emacs" title="Link to this definition">¶</a></dt>
<dd><p>Use emacs keybindings.</p>
</dd></dl>

</section>
<section id="osxphotos-theme">
<h3>theme<a class="headerlink" href="#osxphotos-theme" title="Link to this heading">¶</a></h3>
<p>Manage osxphotos color themes.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>theme<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-default">
<span class="sig-name descname"><span class="pre">--default</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-theme-default" title="Link to this definition">¶</a></dt>
<dd><p>Show default theme.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-list">
<span class="sig-name descname"><span class="pre">--list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-theme-list" title="Link to this definition">¶</a></dt>
<dd><p>List all themes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-config">
<span class="sig-name descname"><span class="pre">--config</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-theme-config" title="Link to this definition">¶</a></dt>
<dd><p>Print configuration for THEME (or default theme if not specified).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-preview">
<span class="sig-name descname"><span class="pre">--preview</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-theme-preview" title="Link to this definition">¶</a></dt>
<dd><p>Preview THEME (or default theme if not specified).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-edit">
<span class="sig-name descname"><span class="pre">--edit</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-theme-edit" title="Link to this definition">¶</a></dt>
<dd><p>Edit THEME (or default theme if not specified).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-clone">
<span class="sig-name descname"><span class="pre">--clone</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME</span> <span class="pre">NEW_THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-theme-clone" title="Link to this definition">¶</a></dt>
<dd><p>Clone THEME to NEW_THEME.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-delete">
<span class="sig-name descname"><span class="pre">--delete</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-theme-delete" title="Link to this definition">¶</a></dt>
<dd><p>Delete THEME.</p>
</dd></dl>

</section>
<section id="osxphotos-timewarp">
<h3>timewarp<a class="headerlink" href="#osxphotos-timewarp" title="Link to this heading">¶</a></h3>
<p>Adjust date/time/timezone of photos in Apple Photos.</p>
<p>Changes will be applied to: 1) photos specified via --uuid and
--uuid-from-file 2) photos specified by one or more query options,
for example, --album &quot;My Album&quot; to specify an album, --added-in-last &quot;1 day&quot;, etc.
3) photos currently selected in Photos in 'Library' / 'All Photos'
or Album views 4) all photos in Album view, if no selection is made.</p>
<p>If you have an Album open and no photos selected, all photos in the album will be edited unless you
specify one or more query options.</p>
<p>See Timewarp Overview below for additional information.</p>
<p>It is recommended you test your changes on a small set of photos before applying them to many photos.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>timewarp<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-d">
<span id="cmdoption-osxphotos-timewarp-date"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-d" title="Link to this definition">¶</a></dt>
<dd><p>Set date for selected photos. Format is 'YYYY-MM-DD'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-D">
<span id="cmdoption-osxphotos-timewarp-date-delta"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--date-delta</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DELTA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-D" title="Link to this definition">¶</a></dt>
<dd><p>Adjust date for selected photos by DELTA. Format is one of: '±D days', '±W weeks', '±D' where D is days</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-t">
<span id="cmdoption-osxphotos-timewarp-time"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--time</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-t" title="Link to this definition">¶</a></dt>
<dd><p>Set time for selected photos. Format is one of 'HH:MM:SS', 'HH:MM:SS.fff', 'HH:MM'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-T">
<span id="cmdoption-osxphotos-timewarp-time-delta"></span><span class="sig-name descname"><span class="pre">-T</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--time-delta</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DELTA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-T" title="Link to this definition">¶</a></dt>
<dd><p>Adjust time for selected photos by DELTA time. Format is one of '±HH:MM:SS', '±H hours' (or hr), '±M minutes' (or min), '±S seconds' (or sec), '±S' (where S is seconds)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-z">
<span id="cmdoption-osxphotos-timewarp-timezone"></span><span class="sig-name descname"><span class="pre">-z</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timezone</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIMEZONE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-z" title="Link to this definition">¶</a></dt>
<dd><p>Set timezone for selected photos as offset from UTC or to named IANA timezone. Format is one of '±HH:MM', '±H:MM', '±HHMM', or named timezone such as 'America/Los_Angeles' or 'PST'. The actual time of the photo is not adjusted which means, somewhat counterintuitively, that the time in the new timezone will be different. For example, if photo has time of 12:00 and timezone of GMT+01:00 and new timezone is specified as '--timezone +02:00' (one hour ahead of current GMT+01:00 timezone), the photo's new time will be 13:00 GMT+02:00, which is equivalent to the old time of 12:00+01:00. This is the same behavior exhibited by Photos when manually adjusting timezone in the Get Info window. See also --match-time which adjusts the time when adjusting the timezone. Note: when a named timezone is provided, daylight savings time will be considered when adjusting the time; it will not be considered when a UTC offset is provided. For list of valid IANA timezone names, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-date-added">
<span class="sig-name descname"><span class="pre">--date-added</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-date-added" title="Link to this definition">¶</a></dt>
<dd><p>Set date/time added for selected photos. This changes the date added or imported date in Photos but does not change the date/time/timezone of the photo itself. This is useful for removing photos from the Recents album, for example if you have imported old scanned photos. Format is 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS'. If time is not included, midnight is assumed. The date/time is assumed to be in the local time zone.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-date-added-from-photo">
<span class="sig-name descname"><span class="pre">--date-added-from-photo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-date-added-from-photo" title="Link to this definition">¶</a></dt>
<dd><p>Set date/time added for selected photos to the date/time the photo was taken. This changes the date added or imported date in Photos but does not change the date/time/timezone of the photo itself. The date/time added will be converted from the photo's timezone to the local time zone.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-R">
<span id="cmdoption-osxphotos-timewarp-reset"></span><span class="sig-name descname"><span class="pre">-R</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--reset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-R" title="Link to this definition">¶</a></dt>
<dd><p>Reset date/time/timezone for selected photos to the original values. This only works on macOS &gt;= 13.0 (Ventura). Photos imported on older versions of macOS may not have an original date/time stored in the Photos database so the command will have no effect for these photos.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-I">
<span id="cmdoption-osxphotos-timewarp-inspect"></span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--inspect</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-I" title="Link to this definition">¶</a></dt>
<dd><p>Print out the date/time/timezone for each selected photo without changing any information.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-c">
<span id="cmdoption-osxphotos-timewarp-compare-exif"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--compare-exif</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-c" title="Link to this definition">¶</a></dt>
<dd><p>Compare the EXIF date/time/timezone for each selected photo to the same data in Photos. Requires the third-party exiftool utility be installed (see <a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>). See also --add-to-album.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-p">
<span id="cmdoption-osxphotos-timewarp-push-exif"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--push-exif</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-p" title="Link to this definition">¶</a></dt>
<dd><p>Push date/time and timezone for selected photos from Photos to the EXIF metadata in the original file in the Photos library. Requires the third-party exiftool utility be installed (see <a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>). Using this option modifies the <em>original</em> file of the image in your Photos library. --push-exif will be executed after any other updates are performed on the photo. Note that if the Photos library is synced to iCloud, the updated EXIF data will not besynced to iCloud and thus exporting the photo on any other device will not show the updated EXIF data. This option is most useful for libraries that are not synced to iCloud. See also --pull-exif.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-P">
<span id="cmdoption-osxphotos-timewarp-pull-exif"></span><span class="sig-name descname"><span class="pre">-P</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--pull-exif</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-P" title="Link to this definition">¶</a></dt>
<dd><p>Pull date/time and timezone for selected photos from EXIF metadata in the original file into Photos and update the associated data in Photos to match the EXIF data. --pull-exif will be executed before any other updates are performed on the photo. It is possible for images to have missing EXIF data, for example the date/time could be set but there might be no timezone set in the EXIF metadata. Missing data will be handled thusly: if date/time/timezone are all present in the EXIF data, the photo's date/time/timezone will be updated. If timezone is missing but date/time is present, only the photo's date/time will be updated.  If date/time is missing but the timezone is present, only the photo's timezone will be updated unless --use-file-time is set in which case, the photo's file modification date/time will be used in place of EXIF date/time. If the date is present but the time is missing, the time will be set to 00:00:00. Requires the third-party exiftool utility be installed (see <a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>). See also --push-exif.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-M">
<span id="cmdoption-osxphotos-timewarp-parse-date"></span><span class="sig-name descname"><span class="pre">-M</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--parse-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE_PATTERN&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-M" title="Link to this definition">¶</a></dt>
<dd><p>Parse date from filename using DATE_PATTERN and set photo's date to match. If file does not match DATE_PATTERN, the date will not be changed. DATE_PATTERN is a strptime-compatible pattern with extensions as pattern described below. If DATE_PATTERN matches time zone information, the photo's timezone will be set to match. For example, if your photos are named 'IMG_1234_2022_11_23_12_34_56.jpg' where the date/time is '2022-11-23 12:34:56', you could use the pattern '%Y_%m_%d_%H_%M_%S' or 'IMG_*_%Y_%m_%d_%H_%M_%S' to further narrow the pattern to only match files with '<a href="#id37"><span class="problematic" id="id38">IMG_xxxx_</span></a>' in the name.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-F">
<span id="cmdoption-osxphotos-timewarp-function"></span><span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--function</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;filename.py::function&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-F" title="Link to this definition">¶</a></dt>
<dd><p>Run python function to determine the date/time/timezone to apply to a photo. Use this in format: --function filename.py::function where filename.py is a python file you've created and function is the name of the function in the python file you want to call.  The function will be passed information about the photo being processed and is expected to return a naive datetime.datetime object with time in local time and UTC timezone offset in seconds. You may also specify a function using a URL in format --function 'https://path/to/module.py::function' See example function at https://github.com/RhetTbull/osxphotos/blob/master/examples/timewarp_function_example.py</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-m">
<span id="cmdoption-osxphotos-timewarp-match-time"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--match-time</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-m" title="Link to this definition">¶</a></dt>
<dd><p>When used with --timezone, adjusts the photo time so that the timestamp in the new timezone matches the timestamp in the old timezone. For example, if photo has time of 12:00 and timezone of GMT+01:00 and new timezone is specified as '--timezone +02:00' (one hour ahead of current GMT+01:00 timezone), the photo's new time will be 12:00 GMT+02:00. That is, the timezone will have changed but the timestamp of the photo will match the previous timestamp. Use --match-time when the camera's time was correct for the time the photo was taken but the timezone was missing or wrong and you want to adjust the timezone while preserving the photo's time. See also --timezone.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-f">
<span id="cmdoption-osxphotos-timewarp-use-file-time"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--use-file-time</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-f" title="Link to this definition">¶</a></dt>
<dd><p>When used with --pull-exif, the file modification date/time will be used if date/time is missing from the EXIF data.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-a">
<span id="cmdoption-osxphotos-timewarp-add-to-album"></span><span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--add-to-album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-a" title="Link to this definition">¶</a></dt>
<dd><p>When used with --compare-exif, adds any photos with date/time/timezone differences between Photos/EXIF to album ALBUM.  If ALBUM does not exist, it will be created.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-album">
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-album" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in album ALBUM. If more than one album, treated as &quot;OR&quot;, e.g. find photos matching any album. For albums in a folder, specify the entire folder path, e.g. 'My Folder/My Album'. If album name contains a forward slash, use double slashes to escape it, e.g. 'Travel//2025' for an album named 'Travel/2025'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-folder">
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FOLDER&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-folder" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos in an album in folder FOLDER. If more than one folder, treated as &quot;OR&quot;, e.g. find photos in any FOLDER. To search subfolders, specify the entire folder path, e.g. 'My Folder/Subfolder'. If folder name contains a forward slash, use double slashes to escape it, e.g. 'My Folder//Subfolder' for a folder named 'My Folder/Subfolder'.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-uuid">
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;UUID&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-uuid" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-uuid-from-file">
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-uuid-from-file" title="Link to this definition">¶</a></dt>
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is '-', read UUIDs from stdin.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-from-date">
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-from-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created on or after DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-to-date">
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-to-date" title="Link to this definition">¶</a></dt>
<dd><p>Search for items created before DATE, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-year">
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;YEAR&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-year" title="Link to this definition">¶</a></dt>
<dd><p>Search for items from a specific year, e.g. --year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-added-before">
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-added-before" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library before a specific date/time, e.g. --added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-added-after">
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;DATE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-added-after" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library on or after a specific date/time, e.g. --added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-added-in-last">
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;TIME_DELTA&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-added-in-last" title="Link to this definition">¶</a></dt>
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like '12 hrs', '1 day', '1d', '1 week', '2weeks', '1 month', '1 year'. for example, '--added-in-last 7d' and '--added-in-last '1 week'' are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-i">
<span id="cmdoption-osxphotos-timewarp-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-i" title="Link to this definition">¶</a></dt>
<dd><p>Case insensitive search when used with other query options.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-V">
<span id="cmdoption-osxphotos-timewarp-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-V" title="Link to this definition">¶</a></dt>
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-timestamp">
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-timestamp" title="Link to this definition">¶</a></dt>
<dd><p>Add time stamp to verbose output</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-L">
<span id="cmdoption-osxphotos-timewarp-library"></span><span class="sig-name descname"><span class="pre">-L</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;PHOTOS_LIBRARY_PATH&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-L" title="Link to this definition">¶</a></dt>
<dd><p>Path to Photos library (e.g. '~/Pictures/PhotosLibrary.photoslibrary'). This is not likely needed as osxphotos will usually be able to locate the path to the open Photos library. Use --library only if you get an error that the Photos library cannot be located.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-e">
<span id="cmdoption-osxphotos-timewarp-exiftool-path"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--exiftool-path</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;exiftool_path&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-e" title="Link to this definition">¶</a></dt>
<dd><p>Optional path to exiftool executable (will look in $PATH if not specified) for those options which require exiftool.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-theme">
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;THEME&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-theme" title="Link to this definition">¶</a></dt>
<dd><p>Specify the color theme to use for output. Valid themes are 'dark', 'light', 'mono', and 'plain'. Defaults to 'dark' or 'light' depending on system dark mode setting.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>dark | light | mono | plain</p>
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-plain">
<span class="sig-name descname"><span class="pre">--plain</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-plain" title="Link to this definition">¶</a></dt>
<dd><p>Plain text mode.  Do not use rich output.</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-force">
<span class="sig-name descname"><span class="pre">--force</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-force" title="Link to this definition">¶</a></dt>
<dd><p>Bypass confirmation prompt.  Use with caution.</p>
</dd></dl>

<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃                                             Timewarp Overview                                              ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
</pre></div>
</div>
<p>Timewarp operates on photos selected in Apple Photos.  To use it, open Photos, select the photos for which
you'd like to adjust the date/time/timezone, then run osxphotos timewarp from the command line:</p>
<p>'osxphotos timewarp --date 2021-09-10 --time-delta &quot;-1 hour&quot; --timezone -0700 --verbose'</p>
<p>A named timezone can also be specified:</p>
<p>'osxphotos timewarp --date 2021-09-10 --time-delta &quot;-1 hour&quot; --timezone &quot;America/Los_Angeles&quot; --verbose'</p>
<p>This example sets the date for all selected photos to '2021-09-10', subtracts 1 hour from the time of each
photo, and sets the timezone of each photo to 'GMT -07:00' (Pacific Daylight Time).</p>
<p>Caution: This app directly modifies your Photos library database using undocumented features.  It may corrupt,
damage, or destroy your Photos library.  Use at your own caution.  I strongly recommend you make a backup of
your Photos library before using this script (e.g. use Time Machine).</p>
<blockquote>
<div><p>Examples</p>
</div></blockquote>
<p>Add 1 day to the date of each photo</p>
<p>'osxphotos timewarp --date-delta 1'</p>
<p>or</p>
<p>'osxphotos timewarp --date-delta &quot;+1 day&quot;'</p>
<p>Set the date of each photo to 23 April 2020 and add 3 hours to the time</p>
<p>'osxphotos timewarp --date 2020-04-23 --time-delta &quot;+3 hours&quot;'</p>
<p>or</p>
<p>'osxphotos timewarp --date 2020-04-23 --time-delta &quot;+03:00:00&quot;'</p>
<p>Set the time of each photo to 14:30 and set the timezone to UTC +1:00 (Central European Time)</p>
<p>'osxphotos timewarp --time 14:30 --timezone +01:00'</p>
<p>or</p>
<p>'osxphotos timewarp --time 14:30 --timezone +0100'</p>
<p>Subtract 1 week from the date for each photo, add 3 hours to the time, set the timezone to UTC -07:00 (Pacific
Daylight Time) and also use exiftool to update the EXIF metadata accordingly in the original file; use
--verbose to print additional details</p>
<p>'osxphotos timewarp --date-delta &quot;-1 week&quot; --time-delta &quot;+3 hours&quot; --timezone -0700 --push-exif --verbose'</p>
<p>For this to work, you'll need to install the third-party exiftool (<a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>) utility.  If you use
homebrew (<a class="reference external" href="https://brew.sh/">https://brew.sh/</a>) you can do this with 'brew install exiftool'.</p>
<p>Set the timezone to UTC +03:00 for each photo but keep the time the same (that is, don't adjust time for the
new timezone)</p>
<p>'osxphotos timewarp --timezone 0300 --match-time'</p>
<p>Note on timezones and times: In Photos, when you change the timezone, Photos assumes the time itself was
correct for the previous timezone and adjusts the time accordingly to the new timezone.  E.g. if the photo's
time is '13:00' and the timezone is 'GMT -07:00' and you adjust the timezone one hour east to 'GMT -06:00',
Photos will change the time of the photo to '14:00'.  osxphotos timewarp follows this behavior.  Using
'--match-time' allows you to adjust the timezone but keep the same time without adjustment. For example, if
your camera clock was correct but lacked timezone information and you took photos in one timezone but imported
them to photos in another, Photos will add the timezone of the computer at time of import.  You can use
osxphotos timewarp to adjust the timezone but keep the time using '--match-time'.</p>
<p>Update the date the photos were added to Photos</p>
<p>'osxphotos timewarp --date-added 2021-09-10'</p>
<p>Update the date the photos were added to Photos to match the date of the photo</p>
<p>'osxphotos timewarp --date-added-from-photo'</p>
<p>Compare the date/time/timezone of selected photos with the date/time/timezone in the photos' original EXIF
metadata</p>
<p>'osxphotos timewarp --compare-exif'</p>
<p>Read the date/time/timezone from the photos' original EXIF metadata to update the photos' date/time/timezone;
if the EXIF data is missing, use the file modification date/time; show verbose output</p>
<p>'osxphotos timewarp --pull-exif --use-file-time --verbose'</p>
<blockquote>
<div><p>Parsing Dates/Times from Filenames</p>
</div></blockquote>
<p>The --parse-date option allows you to parse dates/times from the original filename of the photo. This is
useful if you files with dates/times embedded in the filename but not in the metadata.</p>
<p>The argument to '--parse-date' is a pattern string that is used to parse the date/time from the filename. The
pattern string is a superset of the python 'strftime/strptime' format with the following additions:</p>
<blockquote>
<div><ul>
<li><p><a href="#id27"><span class="problematic" id="id28">*</span></a>: Match any number of characters</p></li>
<li><p>^: Match the beginning of the string</p></li>
<li><p>$: Match the end of the string</p></li>
<li><p>{n}: Match exactly n characters</p></li>
<li><p>{n,}: Match at least n characters</p></li>
<li><p>{n,m}: Match at least n characters and at most m characters</p></li>
<li><p>In addition to '%%' for a literal '%', the following format codes are supported: '%^', '%$', '%', '%|',
'%{', '%}' for '^', '$', '', '|', '{', '}' respectively</p></li>
<li><p><a href="#id29"><span class="problematic" id="id30">|</span></a>: join multiple format codes; each code is tried in order until one matches</p></li>
<li><p>Unlike the standard library, the leading zero is not optional for %d, %m, %H, %I, %M, %S, %j, %U, %W, and</p>
<p>%V</p>
</li>
<li><p>For optional leading zero, use %-d, %-m, %-H, %-I, %-M, %-S, %-j, %-U, %-W, and %-V</p></li>
</ul>
</div></blockquote>
<p>For more information on strptime format codes, see:
<a class="reference external" href="https://docs.python.org/3/library/datetime.html?highlight=strptime#strftime-and-strptime-format-codes">https://docs.python.org/3/library/datetime.html?highlight=strptime#strftime-and-strptime-format-codes</a></p>
</section>
<section id="osxphotos-tutorial">
<h3>tutorial<a class="headerlink" href="#osxphotos-tutorial" title="Link to this heading">¶</a></h3>
<p>Display osxphotos tutorial.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>tutorial<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span><span class="o">[</span>WIDTH<span class="o">]</span>...
</pre></div>
</div>
<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-tutorial-arg-WIDTH">
<span class="sig-name descname"><span class="pre">WIDTH</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-tutorial-arg-WIDTH" title="Link to this definition">¶</a></dt>
<dd><p>Optional argument(s)</p>
</dd></dl>

</section>
<section id="osxphotos-uninstall">
<h3>uninstall<a class="headerlink" href="#osxphotos-uninstall" title="Link to this heading">¶</a></h3>
<p>Uninstall Python packages from the osxphotos environment</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>uninstall<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>PACKAGES...
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-uninstall-y">
<span id="cmdoption-osxphotos-uninstall-yes"></span><span class="sig-name descname"><span class="pre">-y</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--yes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-uninstall-y" title="Link to this definition">¶</a></dt>
<dd><p>Don't ask for confirmation.</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-uninstall-arg-PACKAGES">
<span class="sig-name descname"><span class="pre">PACKAGES</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-uninstall-arg-PACKAGES" title="Link to this definition">¶</a></dt>
<dd><p>Required argument(s)</p>
</dd></dl>

</section>
<section id="osxphotos-update">
<h3>update<a class="headerlink" href="#osxphotos-update" title="Link to this heading">¶</a></h3>
<p>Update the installation to the latest version.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>update<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
</section>
<section id="osxphotos-uuid">
<h3>uuid<a class="headerlink" href="#osxphotos-uuid" title="Link to this heading">¶</a></h3>
<p>Print out unique IDs (UUID) of photos selected in Photos</p>
<p>Prints outs UUIDs in form suitable for --uuid-from-file and --skip-uuid-from-file</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>uuid<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-uuid-f">
<span id="cmdoption-osxphotos-uuid-filename"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--filename</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-uuid-f" title="Link to this definition">¶</a></dt>
<dd><p>Include filename of selected photos in output</p>
</dd></dl>

</section>
<section id="osxphotos-version">
<h3>version<a class="headerlink" href="#osxphotos-version" title="Link to this heading">¶</a></h3>
<p>Check for new version of osxphotos.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos<span class="w"> </span>version<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-version-run">
<span class="sig-name descname"><span class="pre">--run</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;COMMAND&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-version-run" title="Link to this definition">¶</a></dt>
<dd><p>Run COMMAND if there is a new version of osxphotos available.</p>
</dd></dl>

</section>
</section>
</section>

        </article>
      </div>
      <footer>
        
        <div class="related-pages">
          <a class="next-page" href="template_help.html">
              <div class="page-info">
                <div class="context">
                  <span>Next</span>
                </div>
                <div class="title">OSXPhotos Template System</div>
              </div>
              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
            </a>
          <a class="prev-page" href="tutorial.html">
              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
              <div class="page-info">
                <div class="context">
                  <span>Previous</span>
                </div>
                
                <div class="title">OSXPhotos Tutorial</div>
                
              </div>
            </a>
        </div>
        <div class="bottom-of-page">
          <div class="left-details">
            <div class="copyright">
                Copyright &#169; 2021, Rhet Turnbull
            </div>
            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
            
            <a href="https://github.com/pradyunsg/furo">Furo</a>
            
          </div>
          <div class="right-details">
            
          </div>
        </div>
        
      </footer>
    </div>
    <aside class="toc-drawer">
      
      
      <div class="toc-sticky toc-scroll">
        <div class="toc-title-container">
          <span class="toc-title">
            On this page
          </span>
        </div>
        <div class="toc-tree-container">
          <div class="toc-tree">
            <ul>
<li><a class="reference internal" href="#">OSXPhotos Command Line Interface (CLI)</a><ul>
<li><a class="reference internal" href="#osxphotos">osxphotos</a><ul>
<li><a class="reference internal" href="#osxphotos-about">about</a></li>
<li><a class="reference internal" href="#osxphotos-add-locations">add-locations</a></li>
<li><a class="reference internal" href="#osxphotos-albums">albums</a></li>
<li><a class="reference internal" href="#osxphotos-batch-edit">batch-edit</a></li>
<li><a class="reference internal" href="#osxphotos-compare">compare</a></li>
<li><a class="reference internal" href="#osxphotos-docs">docs</a></li>
<li><a class="reference internal" href="#osxphotos-dump">dump</a></li>
<li><a class="reference internal" href="#osxphotos-exiftool">exiftool</a></li>
<li><a class="reference internal" href="#osxphotos-export">export</a></li>
<li><a class="reference internal" href="#osxphotos-exportdb">exportdb</a></li>
<li><a class="reference internal" href="#osxphotos-help">help</a></li>
<li><a class="reference internal" href="#osxphotos-import">import</a></li>
<li><a class="reference internal" href="#osxphotos-info">info</a></li>
<li><a class="reference internal" href="#osxphotos-inspect">inspect</a></li>
<li><a class="reference internal" href="#osxphotos-install">install</a></li>
<li><a class="reference internal" href="#osxphotos-keywords">keywords</a></li>
<li><a class="reference internal" href="#osxphotos-labels">labels</a></li>
<li><a class="reference internal" href="#osxphotos-list">list</a></li>
<li><a class="reference internal" href="#osxphotos-orphans">orphans</a></li>
<li><a class="reference internal" href="#osxphotos-persons">persons</a></li>
<li><a class="reference internal" href="#osxphotos-places">places</a></li>
<li><a class="reference internal" href="#osxphotos-push-exif">push-exif</a></li>
<li><a class="reference internal" href="#osxphotos-query">query</a></li>
<li><a class="reference internal" href="#osxphotos-repl">repl</a></li>
<li><a class="reference internal" href="#osxphotos-run">run</a></li>
<li><a class="reference internal" href="#osxphotos-show">show</a></li>
<li><a class="reference internal" href="#osxphotos-sync">sync</a></li>
<li><a class="reference internal" href="#osxphotos-template">template</a></li>
<li><a class="reference internal" href="#osxphotos-theme">theme</a></li>
<li><a class="reference internal" href="#osxphotos-timewarp">timewarp</a></li>
<li><a class="reference internal" href="#osxphotos-tutorial">tutorial</a></li>
<li><a class="reference internal" href="#osxphotos-uninstall">uninstall</a></li>
<li><a class="reference internal" href="#osxphotos-update">update</a></li>
<li><a class="reference internal" href="#osxphotos-uuid">uuid</a></li>
<li><a class="reference internal" href="#osxphotos-version">version</a></li>
</ul>
</li>
</ul>
</li>
</ul>

          </div>
        </div>
      </div>
      
      
    </aside>
  </div>
</div><script src="_static/documentation_options.js?v=63568c49"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/scripts/furo.js?v=46bd48cc"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=f281be69"></script>
    </body>
</html>